build: add describe.py to scripts folder to fix failing Github Action (…

…#2125) * build: move describe.py to scripts folder * Remove obsolete path in noxfile * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * adjust coverage level for scripts folder * revstore describe.py; add symlink in scripts folder * revert changes to noxfile * revert whitespace change * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add artifact_destination_dir arg * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * exclude coverage for describe.py * add default value for artifact_destination_dir * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix typo * fix path in generate_all_api_documents * address review comments --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · May 24, 2023 · 13dcce2 · 13dcce2
1 parent 121d281
commit 13dcce2
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 12 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -1,5 +1,8 @@
 [report]
-omit = */samples/*
+omit =
+    */samples/*
+    # Issue tracked in https://github.com/googleapis/google-api-python-client/issues/2132
+    describe.py
 exclude_lines =
     # Re-enable the standard pragma
     pragma: NO COVER

diff --git a/describe.py b/describe.py
@@ -38,7 +38,7 @@
 from googleapiclient.http import build_http
 
 DISCOVERY_DOC_DIR = (
-    pathlib.Path(__file__).parent.resolve()
+    pathlib.Path(__file__).resolve().parent
     / "googleapiclient"
     / "discovery_cache"
     / "documents"
@@ -134,7 +134,7 @@
   <code><a href="#$name">$name($params)</a></code></p>
 <p class="firstline">$firstline</p>"""
 
-BASE = pathlib.Path(__file__).parent.resolve() / "docs" / "dyn"
+BASE = pathlib.Path(__file__).resolve().parent / "docs" / "dyn"
 
 DIRECTORY_URI = "https://www.googleapis.com/discovery/v1/apis"
 
@@ -356,7 +356,12 @@ def document_collection(resource, path, root_discovery, discovery, css=CSS):
 
 
 def document_collection_recursive(
-    resource, path, root_discovery, discovery, doc_destination_dir
+    resource,
+    path,
+    root_discovery,
+    discovery,
+    doc_destination_dir,
+    artifact_destination_dir=DISCOVERY_DOC_DIR,
 ):
     html = document_collection(resource, path, root_discovery, discovery)
 
@@ -380,10 +385,13 @@ def document_collection_recursive(
                 root_discovery,
                 discovery["resources"].get(dname, {}),
                 doc_destination_dir,
+                artifact_destination_dir,
             )
 
 
-def document_api(name, version, uri, doc_destination_dir):
+def document_api(
+    name, version, uri, doc_destination_dir, artifact_destination_dir=DISCOVERY_DOC_DIR
+):
     """Document the given API.
 
     Args:
@@ -392,6 +400,8 @@ def document_api(name, version, uri, doc_destination_dir):
         uri (str): URI of the API's discovery document
         doc_destination_dir (str): relative path where the reference
             documentation should be saved.
+        artifact_destination_dir (str): relative path where the discovery
+            artifacts should be saved.
     """
     http = build_http()
     resp, content = http.request(
@@ -405,7 +415,7 @@ def document_api(name, version, uri, doc_destination_dir):
         discovery = json.loads(content)
         service = build_from_document(discovery)
         doc_name = "{}.{}.json".format(name, version)
-        discovery_file_path = DISCOVERY_DOC_DIR / doc_name
+        discovery_file_path = artifact_destination_dir / doc_name
         revision = None
 
         pathlib.Path(discovery_file_path).touch(exist_ok=True)
@@ -445,16 +455,21 @@ def document_api(name, version, uri, doc_destination_dir):
         discovery,
         discovery,
         doc_destination_dir,
+        artifact_destination_dir,
     )
 
 
-def document_api_from_discovery_document(discovery_url, doc_destination_dir):
+def document_api_from_discovery_document(
+    discovery_url, doc_destination_dir, artifact_destination_dir=DISCOVERY_DOC_DIR
+):
     """Document the given API.
 
     Args:
       discovery_url (str): URI of discovery document.
       doc_destination_dir (str): relative path where the reference
           documentation should be saved.
+      artifact_destination_dir (str): relative path where the discovery
+          artifacts should be saved.
     """
     http = build_http()
     response, content = http.request(discovery_url)
@@ -471,16 +486,23 @@ def document_api_from_discovery_document(discovery_url, doc_destination_dir):
         discovery,
         discovery,
         doc_destination_dir,
+        artifact_destination_dir,
     )
 
 
-def generate_all_api_documents(directory_uri=DIRECTORY_URI, doc_destination_dir=BASE):
+def generate_all_api_documents(
+    directory_uri=DIRECTORY_URI,
+    doc_destination_dir=BASE,
+    artifact_destination_dir=DISCOVERY_DOC_DIR,
+):
     """Retrieve discovery artifacts and fetch reference documentations
     for all apis listed in the public discovery directory.
     args:
         directory_uri (str): uri of the public discovery directory.
         doc_destination_dir (str): relative path where the reference
             documentation should be saved.
+        artifact_destination_dir (str): relative path where the discovery
+            artifacts should be saved.
     """
     api_directory = collections.defaultdict(list)
     http = build_http()
@@ -493,6 +515,7 @@ def generate_all_api_documents(directory_uri=DIRECTORY_URI, doc_destination_dir=
                 api["version"],
                 api["discoveryRestUrl"],
                 doc_destination_dir,
+                artifact_destination_dir,
             )
             api_directory[api["name"]].append(api["version"])
 
@@ -513,7 +536,7 @@ def generate_all_api_documents(directory_uri=DIRECTORY_URI, doc_destination_dir=
                 )
             markdown.append("\n")
 
-        with open(BASE / "index.md", "w") as f:
+        with open(doc_destination_dir / "index.md", "w") as f:
             markdown = "\n".join(markdown)
             f.write(markdown)
 
@@ -525,9 +548,11 @@ def generate_all_api_documents(directory_uri=DIRECTORY_URI, doc_destination_dir=
     FLAGS = parser.parse_args(sys.argv[1:])
     if FLAGS.discovery_uri:
         document_api_from_discovery_document(
-            discovery_url=FLAGS.discovery_uri, doc_destination_dir=FLAGS.dest
+            discovery_url=FLAGS.discovery_uri,
+            doc_destination_dir=FLAGS.dest,
         )
     else:
         generate_all_api_documents(
-            directory_uri=FLAGS.directory_uri, doc_destination_dir=FLAGS.dest
+            directory_uri=FLAGS.directory_uri,
+            doc_destination_dir=FLAGS.dest,
         )
diff --git a/scripts/describe.py b/scripts/describe.py
@@ -0,0 +1 @@
+../describe.py
diff --git a/scripts/updatediscoveryartifacts.py b/scripts/updatediscoveryartifacts.py
@@ -45,7 +45,10 @@
     shutil.copytree(DISCOVERY_DOC_DIR, current_discovery_doc_dir, dirs_exist_ok=True)
 
     # Download discovery artifacts and generate documentation
-    describe.generate_all_api_documents()
+    describe.generate_all_api_documents(
+        doc_destination_dir=REFERENCE_DOC_DIR,
+        artifact_destination_dir=DISCOVERY_DOC_DIR,
+    )
 
     # Get a list of files changed using `git diff`
     git_diff_output = subprocess.check_output(