fix: log a warning and continue on invalid sample metadata yaml (#1230)

* test: failing test for bad metadata

* fix: log a warning and continue on invalid sample metadata yaml

* chore: fix lint

* chore: fix lint

Author: chingor13

synthtool/gcp/samples.py

@@ -17,6 +17,7 @@
 import os
 import yaml
 from typing import List, Dict
+from synthtool.log import logger
 
 
 def _read_sample_metadata_comment(sample_file: str) -> Dict:
@@ -37,9 +38,13 @@ def _read_sample_metadata_comment(sample_file: str) -> Dict:
             # the metadata yaml is stored in a comments, remove the
             # prefix so that we can parse the yaml contained.
             sample_metadata_string = re.sub(r"((#|//) ?)", "", match.group("metadata"))
-            sample_metadata = yaml.load(sample_metadata_string, Loader=yaml.SafeLoader)[
-                "sample-metadata"
-            ]
+            try:
+                sample_metadata = yaml.load(
+                    sample_metadata_string, Loader=yaml.SafeLoader
+                )["sample-metadata"]
+            except yaml.scanner.ScannerError:
+                # warn and continue on bad metadata
+                logger.warning(f"bad metadata detected in {sample_file}")
     return sample_metadata
 
 

tests/fixtures/node_templates/bad_metadata/samples/bad_metadata1.js

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2019, Google, Inc.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//
+// sample-metadata:
+//   title: Metadata Example 1
+//   description: this is a description.
+// bad wrapping here
+//   usage: node hello-world.js
+//
+'use strict';
+
+async function viewBucketIamMembers(bucketName) {
+  // [START storage_view_bucket_iam_members]
+  // Imports the Google Cloud client library
+  // [END storage_view_bucket_iam_members]
+}

tests/fixtures/node_templates/bad_metadata/samples/meta1.js

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2019, Google, Inc.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//
+// sample-metadata:
+//   title: Metadata Example 1
+//   description: this is a description.
+//   usage: node hello-world.js
+//
+'use strict';
+
+async function viewBucketIamMembers(bucketName) {
+  // [START storage_view_bucket_iam_members]
+  // Imports the Google Cloud client library
+  // [END storage_view_bucket_iam_members]
+}

tests/test_samples.py

@@ -33,3 +33,14 @@ def test_load_node_samples():
         assert all_samples[0]["usage"] == "node hello-world.js"
         assert all_samples[1]["title"] == "Metadata Example 2"
         assert all_samples[1]["usage"] == "node goodnight-moon.js"
+
+
+def test_bad_metadata():
+    with util.chdir(FIXTURES / "node_templates" / "bad_metadata"):
+        all_samples = samples.all_samples(["samples/*.js"])
+
+        # should have included additional meta-information provided.
+        assert all_samples[0]["title"] == "Bad_metadata1"
+        assert "usage" not in all_samples[0]
+        assert all_samples[1]["title"] == "Metadata Example 1"
+        assert all_samples[1]["usage"] == "node hello-world.js"