Updated admin nox configuration and contributors guide

1.  Copied
    https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile-template.py
    to noxfile.py.
2.  Modified noxfile_config.py to allow env variable overrides.
3.  Updated the contributors guide to include sections on style and
    tests.

Author: jradcliff

CONTRIBUTING.md

@@ -27,3 +27,66 @@ information on using pull requests.
 This project follows [Google's Open Source Community
 Guidelines](https://opensource.google.com/conduct/).
 
+## Code Style
+
+All Python samples should follow the best practices defined in the [PEP 8 style
+guide](https://www.python.org/dev/peps/pep-0008/) and the [Google Python Style
+Guide](http://google.github.io/styleguide/pyguide.html). The automated linting
+process for Python samples uses [flake8](http://flake8.pycqa.org/en/latest/) to
+verify conformance to common Python coding standards, so the use of flake8 is
+recommended.
+
+If you prefer to use [pylint](https://www.pylint.org/), note that Python samples
+for this repo are not required to conform to pylint’s default settings outside
+the scope of PEP 8, such as the “too many arguments” or “too many local
+variables” warnings.
+
+The use of [Black](https://pypi.org/project/black/) to standardize code
+formatting and simplify diffs is recommended.
+
+The default noxfile defines a `blacken` session for convenience. If you have
+pyenv configured, you can check and format all files in `google-analytics-admin`
+or `google-analytics-data` using the following command:
+
+```sh
+nox -s lint blacken
+```
+
+## Running the tests
+
+1.  Configure your environment and credentials as described in the
+    [README](README.md).
+2.  Determine which GA4 property you want to use for tests, and note its
+    property ID.
+3.  Change into the directory of the project you want to test (either
+    `google-analytics-admin` or `google-analytics-data`).
+4.  Configure environment variables required by tests using the following
+    commands:
+
+    ```sh
+    # These values are required by Admin and Data API samples tests.
+    export GOOGLE_CLOUD_PROJECT=
+    export GA_TEST_PROPERTY_ID=
+    # These values are only required by Admin API samples tests.
+    export GA_TEST_ACCOUNT_ID=
+    export GA_TEST_WEB_DATA_STREAM_ID=
+    export GA_TEST_WEB_DATA_SECRET_ID=
+    export GA_TEST_CONVERSION_EVENT_ID=
+    ```
+
+5.  Execute tests from the `google-analytics-admin` or `google-analytics-data`
+    directory, using either `nox` or `pytest`. Using `nox` provides the
+    additional benefit of formatting all files, and also automatically creates a
+    virtual environment to test samples using different versions of Python.
+
+    *   Using `nox`:
+
+        ```sh
+        nox
+        ```
+
+    *   Using `pytest`:
+
+        ```sh
+        pytest
+        ```

google-analytics-admin/noxfile.py

@@ -12,35 +12,35 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
 from __future__ import print_function
 
+from collections.abc import Callable
 import glob
 import os
 from pathlib import Path
 import sys
-from typing import Callable, Dict, Optional
 
 import nox
 
+
 # WARNING - WARNING - WARNING - WARNING - WARNING
 # WARNING - WARNING - WARNING - WARNING - WARNING
-#           DO NOT EDIT THIS FILE EVER!
+#       BE CAREFUL WHEN EDITING THIS FILE!
 # WARNING - WARNING - WARNING - WARNING - WARNING
 # WARNING - WARNING - WARNING - WARNING - WARNING
 
-BLACK_VERSION = "black==22.3.0"
-ISORT_VERSION = "isort==5.10.1"
-
 # Copy `noxfile_config.py` to your directory and modify it instead.
 
+
 # `TEST_CONFIG` dict is a configuration hook that allows users to
 # modify the test configurations. The values here should be in sync
 # with `noxfile_config.py`. Users will copy `noxfile_config.py` into
 # their directory and modify it.
 
 TEST_CONFIG = {
     # You can opt out from the test for specific Python versions.
-    "ignored_versions": [],
+    "ignored_versions": ["2.7", "3.7", "3.9", "3.10", "3.11"],
     # Old samples are opted out of enforcing Python type hints
     # All new samples should feature them
     "enforce_type_hints": False,
@@ -72,33 +72,30 @@
 TEST_CONFIG.update(TEST_CONFIG_OVERRIDE)
 
 
-def get_pytest_env_vars() -> Dict[str, str]:
+def get_pytest_env_vars() -> dict[str, str]:
     """Returns a dict for pytest invocation."""
     ret = {}
 
     # Override the GCLOUD_PROJECT and the alias.
     env_key = TEST_CONFIG["gcloud_project_env"]
     # This should error out if not set.
     ret["GOOGLE_CLOUD_PROJECT"] = os.environ[env_key]
+    ret["GCLOUD_PROJECT"] = os.environ[env_key]  # deprecated
 
     # Apply user supplied envs.
     ret.update(TEST_CONFIG["envs"])
     return ret
 
 
-# DO NOT EDIT - automatically generated.
-# All versions used to test samples.
-ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11"]
+# All versions used to tested samples.
+ALL_VERSIONS = ["2.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
 # Any default versions that should be ignored.
 IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"]
 
 TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS])
 
-INSTALL_LIBRARY_FROM_SOURCE = os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False) in (
-    "True",
-    "true",
-)
+INSTALL_LIBRARY_FROM_SOURCE = bool(os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False))
 
 # Error if a python version is missing
 nox.options.error_on_missing_interpreters = True
@@ -108,9 +105,26 @@ def get_pytest_env_vars() -> Dict[str, str]:
 #
 
 
+def _determine_local_import_names(start_dir: str) -> list[str]:
+    """Determines all import names that should be considered "local".
+
+    This is used when running the linter to ensure that import order is
+    properly checked.
+    """
+    file_ext_pairs = [os.path.splitext(path) for path in os.listdir(start_dir)]
+    return [
+        basename
+        for basename, extension in file_ext_pairs
+        if extension == ".py"
+        or os.path.isdir(os.path.join(start_dir, basename))
+        and basename not in ("__pycache__")
+    ]
+
+
 # Linting with flake8.
 #
 # We ignore the following rules:
+#   ANN101: missing type annotation for self in method
 #   E203: whitespace before ‘:’
 #   E266: too many leading ‘#’ for block comment
 #   E501: line too long
@@ -122,20 +136,24 @@ def get_pytest_env_vars() -> Dict[str, str]:
     "--show-source",
     "--builtin=gettext",
     "--max-complexity=20",
+    "--import-order-style=google",
     "--exclude=.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py",
-    "--ignore=E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202",
+    "--ignore=ANN101,E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202",
     "--max-line-length=88",
 ]
 
 
 @nox.session
 def lint(session: nox.sessions.Session) -> None:
     if not TEST_CONFIG["enforce_type_hints"]:
-        session.install("flake8")
+        session.install("flake8", "flake8-import-order")
     else:
-        session.install("flake8", "flake8-annotations")
+        session.install("flake8", "flake8-import-order", "flake8-annotations")
 
+    local_names = _determine_local_import_names(".")
     args = FLAKE8_COMMON_ARGS + [
+        "--application-import-names",
+        ",".join(local_names),
         ".",
     ]
     session.run("flake8", *args)
@@ -148,30 +166,9 @@ def lint(session: nox.sessions.Session) -> None:
 
 @nox.session
 def blacken(session: nox.sessions.Session) -> None:
-    """Run black. Format code to uniform standard."""
-    session.install(BLACK_VERSION)
-    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
-
-    session.run("black", *python_files)
-
-
-#
-# format = isort + black
-#
-
-
-@nox.session
-def format(session: nox.sessions.Session) -> None:
-    """
-    Run isort to sort imports. Then run black
-    to format code to uniform standard.
-    """
-    session.install(BLACK_VERSION, ISORT_VERSION)
+    session.install("black")
     python_files = [path for path in os.listdir(".") if path.endswith(".py")]
 
-    # Use the --fss option to sort imports using strict alphabetical order.
-    # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections
-    session.run("isort", "--fss", *python_files)
     session.run("black", *python_files)
 
 
@@ -187,10 +184,8 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
-    test_list.extend(glob.glob("**/tests", recursive=True))
+    test_list = glob.glob("*_test.py") + glob.glob("test_*.py")
+    test_list.extend(glob.glob("tests"))
 
     if len(test_list) == 0:
         print("No tests found, skipping directory.")
@@ -199,23 +194,42 @@ def _session_tests(
     if TEST_CONFIG["pip_version_override"]:
         pip_version = TEST_CONFIG["pip_version_override"]
         session.install(f"pip=={pip_version}")
+    else:
+        session.install("--upgrade", "pip")
+
     """Runs py.test for a particular project."""
     concurrent_args = []
     if os.path.exists("requirements.txt"):
-        if os.path.exists("constraints.txt"):
-            session.install("-r", "requirements.txt", "-c", "constraints.txt")
-        else:
-            session.install("-r", "requirements.txt")
         with open("requirements.txt") as rfile:
             packages = rfile.read()
+        if os.path.exists("constraints.txt"):
+            session.install(
+                "-r",
+                "requirements.txt",
+                "-c",
+                "constraints.txt",
+                "--only-binary",
+                ":all",
+            )
+        elif "pyspark" in packages:
+            session.install("-r", "requirements.txt", "--use-pep517")
+        else:
+            session.install("-r", "requirements.txt", "--only-binary", ":all")
 
     if os.path.exists("requirements-test.txt"):
-        if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
-        else:
-            session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
             packages += rtfile.read()
+        if os.path.exists("constraints-test.txt"):
+            session.install(
+                "-r",
+                "requirements-test.txt",
+                "-c",
+                "constraints-test.txt",
+                "--only-binary",
+                ":all",
+            )
+        else:
+            session.install("-r", "requirements-test.txt", "--only-binary", ":all")
 
     if INSTALL_LIBRARY_FROM_SOURCE:
         session.install("-e", _get_repo_root())
@@ -255,20 +269,16 @@ def py(session: nox.sessions.Session) -> None:
 #
 
 
-def _get_repo_root() -> Optional[str]:
+def _get_repo_root() -> str | None:
     """Returns the root folder of the project."""
-    # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
+    # Get root of this repository.
+    # Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):
         if p is None:
             break
         if Path(p / ".git").exists():
             return str(p)
-        # .git is not available in repos cloned via Cloud Build
-        # setup.py is always in the library's root, so use that instead
-        # https://github.com/googleapis/synthtool/issues/792
-        if Path(p / "setup.py").exists():
-            return str(p)
         p = p.parent
     raise Exception("Unable to detect repository root.")
 

google-analytics-admin/noxfile_config.py

@@ -12,22 +12,30 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+
 TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7"],
     # An envvar key for determining the project id to use. Change it
     # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
     # build specific Cloud project. You can also use your own string
     # to use your own Cloud project.
-    "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT",
+    "gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
     # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
     # A dictionary you want to inject into your test. Don't put any
     # secrets here. These values will override predefined values.
     "envs": {
-        "GA_TEST_PROPERTY_ID": "276206997",
-        "GA_TEST_ACCOUNT_ID": "199820965",
-        "GA_TEST_USER_LINK_ID": "103401743041912607932",
-        "GA_TEST_PROPERTY_USER_LINK_ID": "105231969274497648555",
-        "GA_TEST_WEB_DATA_STREAM_ID": "2828068992",
-        "GA_TEST_WEB_DATA_SECRET_ID": "2994983412",
-        "GA_TEST_CONVERSION_EVENT_ID": "2719963095",
+        "GA_TEST_PROPERTY_ID": os.getenv("GA_TEST_PROPERTY_ID", "276206997"),
+        "GA_TEST_ACCOUNT_ID": os.getenv("GA_TEST_ACCOUNT_ID", "199820965"),
+        "GA_TEST_WEB_DATA_STREAM_ID": os.getenv(
+            "GA_TEST_WEB_DATA_STREAM_ID", "2828068992"
+        ),
+        "GA_TEST_WEB_DATA_SECRET_ID": os.getenv(
+            "GA_TEST_WEB_DATA_SECRET_ID", "2994983412"
+        ),
+        "GA_TEST_CONVERSION_EVENT_ID": os.getenv(
+            "GA_TEST_CONVERSION_EVENT_ID", "2719963095"
+        ),
     },
 }