feat: add support for python 3.10 (#131)

* feat: add support for python 3.10 * add constraints files for python 3.10 and 3.11
googleapis · Oct 14, 2021 · 8d400f9 · 8d400f9
1 parent 1d182b5
commit 8d400f9
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 74 deletions.
diff --git a/packages/google-cloud-compute/.kokoro/samples/lint/common.cfg b/packages/google-cloud-compute/.kokoro/samples/lint/common.cfg
@@ -31,4 +31,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
 gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
 
 # Use the trampoline script to run in docker.
-build_file: "python-compute/.kokoro/trampoline.sh"
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.10/common.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.10/common.cfg
@@ -0,0 +1,40 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+# Build logs will be here
+action {
+  define_artifacts {
+    regex: "**/*sponge_log.xml"
+  }
+}
+
+# Specify which tests to run
+env_vars: {
+    key: "RUN_TESTS_SESSION"
+    value: "py-3.10"
+}
+
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-310"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-compute/.kokoro/test-samples.sh"
+}
+
+# Configure the docker image for kokoro-trampoline.
+env_vars: {
+    key: "TRAMPOLINE_IMAGE"
+    value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
+}
+
+# Download secrets for samples
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
+
+# Download trampoline resources.
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
+
+# Use the trampoline script to run in docker.
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.10/continuous.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.10/continuous.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.10/periodic-head.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.10/periodic-head.cfg
@@ -0,0 +1,11 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-compute/.kokoro/test-samples-against-head.sh"
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.10/periodic.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.10/periodic.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "False"
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.10/presubmit.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.10/presubmit.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.6/common.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.6/common.cfg
@@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
 gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
 
 # Use the trampoline script to run in docker.
-build_file: "python-compute/.kokoro/trampoline.sh"
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.6/periodic.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.6/periodic.cfg
@@ -3,4 +3,4 @@
 env_vars: {
     key: "INSTALL_LIBRARY_FROM_SOURCE"
     value: "False"
-}
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.7/common.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.7/common.cfg
@@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
 gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
 
 # Use the trampoline script to run in docker.
-build_file: "python-compute/.kokoro/trampoline.sh"
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.7/periodic.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.7/periodic.cfg
@@ -3,4 +3,4 @@
 env_vars: {
     key: "INSTALL_LIBRARY_FROM_SOURCE"
     value: "False"
-}
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.8/common.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.8/common.cfg
@@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
 gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
 
 # Use the trampoline script to run in docker.
-build_file: "python-compute/.kokoro/trampoline.sh"
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.8/periodic.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.8/periodic.cfg
@@ -3,4 +3,4 @@
 env_vars: {
     key: "INSTALL_LIBRARY_FROM_SOURCE"
     value: "False"
-}
+}
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.9/common.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.9/common.cfg
@@ -37,4 +37,4 @@ gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
 gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
 
 # Use the trampoline script to run in docker.
-build_file: "python-compute/.kokoro/trampoline.sh"
+build_file: "python-compute/.kokoro/trampoline_v2.sh"
diff --git a/packages/google-cloud-compute/.kokoro/samples/python3.9/periodic.cfg b/packages/google-cloud-compute/.kokoro/samples/python3.9/periodic.cfg
@@ -3,4 +3,4 @@
 env_vars: {
     key: "INSTALL_LIBRARY_FROM_SOURCE"
     value: "False"
-}
+}
diff --git a/packages/google-cloud-compute/.kokoro/test-samples-against-head.sh b/packages/google-cloud-compute/.kokoro/test-samples-against-head.sh
@@ -23,6 +23,4 @@ set -eo pipefail
 # Enables `**` to include files nested inside sub-folders
 shopt -s globstar
 
-cd github/python-compute
-
 exec .kokoro/test-samples-impl.sh
diff --git a/packages/google-cloud-compute/.kokoro/test-samples.sh b/packages/google-cloud-compute/.kokoro/test-samples.sh
@@ -24,8 +24,6 @@ set -eo pipefail
 # Enables `**` to include files nested inside sub-folders
 shopt -s globstar
 
-cd github/python-compute
-
 # Run periodic samples tests at latest release
 if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
     # preserving the test runner implementation.

diff --git a/packages/google-cloud-compute/.trampolinerc b/packages/google-cloud-compute/.trampolinerc
@@ -16,15 +16,26 @@
 
 # Add required env vars here.
 required_envvars+=(
-    "STAGING_BUCKET"
-    "V2_STAGING_BUCKET"
 )
 
 # Add env vars which are passed down into the container here.
 pass_down_envvars+=(
+    "NOX_SESSION"
+    ###############
+    # Docs builds
+    ###############
     "STAGING_BUCKET"
     "V2_STAGING_BUCKET"
-    "NOX_SESSION"
+    ##################
+    # Samples builds
+    ##################
+    "INSTALL_LIBRARY_FROM_SOURCE"
+    "RUN_TESTS_SESSION"
+    "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    # Target directories.
+    "RUN_TESTS_DIRS"
+    # The nox session to run.
+    "RUN_TESTS_SESSION"
 )
 
 # Prevent unintentional override on the default image.

diff --git a/packages/google-cloud-compute/CONTRIBUTING.rst b/packages/google-cloud-compute/CONTRIBUTING.rst
@@ -22,7 +22,7 @@ In order to add a feature:
   documentation.
 
 - The feature must work fully on the following CPython versions:
-  3.6, 3.7, 3.8 and 3.9 on both UNIX and Windows.
+  3.6, 3.7, 3.8, 3.9 and 3.10 on both UNIX and Windows.
 
 - The feature must not add unnecessary dependencies (where
   "unnecessary" is of course subjective, but new dependencies should
@@ -72,7 +72,7 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
 
 - To run a single unit test::
 
-    $ nox -s unit-3.9 -- -k <name of test>
+    $ nox -s unit-3.10 -- -k <name of test>
 
 
   .. note::
@@ -225,11 +225,13 @@ We support:
 -  `Python 3.7`_
 -  `Python 3.8`_
 -  `Python 3.9`_
+-  `Python 3.10`_
 
 .. _Python 3.6: https://docs.python.org/3.6/
 .. _Python 3.7: https://docs.python.org/3.7/
 .. _Python 3.8: https://docs.python.org/3.8/
 .. _Python 3.9: https://docs.python.org/3.9/
+.. _Python 3.10: https://docs.python.org/3.10/
 
 
 Supported versions can be found in our ``noxfile.py`` `config`_.

diff --git a/packages/google-cloud-compute/noxfile.py b/packages/google-cloud-compute/noxfile.py
@@ -29,7 +29,7 @@
 
 DEFAULT_PYTHON_VERSION = "3.8"
 SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"]
-UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"]
+UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
 CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()
 

diff --git a/packages/google-cloud-compute/samples/snippets/noxfile.py b/packages/google-cloud-compute/samples/snippets/noxfile.py
@@ -87,7 +87,7 @@ def get_pytest_env_vars() -> Dict[str, str]:
 
 # DO NOT EDIT - automatically generated.
 # All versions used to test samples.
-ALL_VERSIONS = ["3.6", "3.7", "3.8", "3.9"]
+ALL_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
 # Any default versions that should be ignored.
 IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"]

diff --git a/packages/google-cloud-compute/setup.py b/packages/google-cloud-compute/setup.py
@@ -56,9 +56,13 @@
         "Development Status :: 3 - Alpha",
         "Intended Audience :: Developers",
         "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "Topic :: Internet",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],

diff --git a/packages/google-cloud-compute/synth.py b/packages/google-cloud-compute/synth.py
@@ -45,60 +45,6 @@
   templated_files, excludes=[".coveragerc"] # the microgenerator has a good coveragerc file
 )
 
-# Remove the replacements below once https://github.com/googleapis/synthtool/pull/1188 is merged
-
-# Update googleapis/repo-automation-bots repo to main in .kokoro/*.sh files
-s.replace(".kokoro/*.sh", "repo-automation-bots/tree/master", "repo-automation-bots/tree/main")
-
-# Customize CONTRIBUTING.rst to replace master with main
-s.replace(
-    "CONTRIBUTING.rst",
-    "fetch and merge changes from upstream into master",
-    "fetch and merge changes from upstream into main",
-)
-
-s.replace(
-    "CONTRIBUTING.rst",
-    "git merge upstream/master",
-    "git merge upstream/main",
-)
-
-s.replace(
-    "CONTRIBUTING.rst",
-    """export GOOGLE_CLOUD_TESTING_BRANCH=\"master\"""",
-    """export GOOGLE_CLOUD_TESTING_BRANCH=\"main\"""",
-)
-
-s.replace(
-    "CONTRIBUTING.rst",
-    "remote \(``master``\)",
-    "remote (``main``)",
-)
-
-s.replace(
-    "CONTRIBUTING.rst",
-    "blob/master/CONTRIBUTING.rst",
-    "blob/main/CONTRIBUTING.rst",
-)
-
-s.replace(
-    "CONTRIBUTING.rst",
-    "blob/master/noxfile.py",
-    "blob/main/noxfile.py",
-)
-
-s.replace(
-    "docs/conf.py",
-    "master_doc",
-    "root_doc",
-)
-
-s.replace(
-    "docs/conf.py",
-    "# The master toctree document.",
-    "# The root toctree document.",
-)
-
 # --------------------------------------------------------------------------
 # Samples templates
 # --------------------------------------------------------------------------

diff --git a/packages/google-cloud-compute/testing/constraints-3.10.txt b/packages/google-cloud-compute/testing/constraints-3.10.txt
diff --git a/packages/google-cloud-compute/testing/constraints-3.11.txt b/packages/google-cloud-compute/testing/constraints-3.11.txt