Add generation tests for private repos

Golden tests are done for all repo types setting them as private repos,
and a full generation integration smoke test is done for an API private
repo.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Author: llucax

tests/integration/test_cookiecutter_generation.py

@@ -26,15 +26,25 @@
 """
 
 
-@pytest.mark.integration
-@pytest.mark.cookiecutter
-@pytest.mark.parametrize("repo_type", [*config.RepositoryType])
-def test_golden(
-    tmp_path: pathlib.Path,
-    repo_type: config.RepositoryType,
-    request: pytest.FixtureRequest,
-) -> None:
-    """Test generation of a new repo comparing it to a golden tree."""
+PROPRIETARY_TEST_REPO_TYPE = config.RepositoryType.API
+
+
+def _license_context(license_name: str) -> dict[str, str] | None:
+    """Get extra cookiecutter context for a license override."""
+    if license_name == "MIT":
+        return None
+    return {"license": license_name}
+
+
+def _golden_case_name(repo_type: config.RepositoryType, *, license_name: str) -> str:
+    """Get the golden test case name for a repository type and license."""
+    if license_name == "MIT":
+        return repo_type.value
+    return f"{repo_type.value}-{license_name.lower()}"
+
+
+def _golden_test_env() -> dict[str, str]:
+    """Get a deterministic environment for golden cookiecutter tests."""
     env = os.environ.copy()
     env.update(
         # Make sure file sorting, dates, etc. are deterministic.
@@ -45,17 +55,31 @@ def test_golden(
         # some flaky outputs can be disabled.
         GOLDEN_TEST="1",
     )
+    return env
 
+
+def _assert_golden_generation(
+    tmp_path: pathlib.Path,
+    repo_type: config.RepositoryType,
+    request: pytest.FixtureRequest,
+    *,
+    license_name: str = "MIT",
+) -> None:
+    """Assert a generated repository matches its golden files."""
     cwd = pathlib.Path().cwd()
     golden_path = (
         cwd
         / "tests_golden"
         / request.path.relative_to(cwd / "tests").with_suffix("")
-        / repo_type.value
+        / _golden_case_name(repo_type, license_name=license_name)
     )
 
     generated_repo_path, run_result = _generate_repo(
-        repo_type, tmp_path, capture_output=True, env=env
+        repo_type,
+        tmp_path,
+        capture_output=True,
+        extra_context=_license_context(license_name),
+        env=_golden_test_env(),
     )
     stdout, stderr = _filter_generation_output(run_result)
     _assert_golden_file(golden_path, "cookiecutter-stdout", stdout)
@@ -66,23 +90,88 @@ def test_golden(
     )
 
 
-@pytest.mark.integration
-@pytest.mark.cookiecutter
-@pytest.mark.parametrize("repo_type", [*config.RepositoryType])
-def test_generation(tmp_path: pathlib.Path, repo_type: config.RepositoryType) -> None:
-    """Test generation of a new repo."""
+def _assert_generated_repo_checks(
+    tmp_path: pathlib.Path,
+    repo_type: config.RepositoryType,
+    *,
+    license_name: str = "MIT",
+) -> None:
+    """Assert a generated repository passes the basic nox checks."""
     cwd = pathlib.Path().cwd()
-    repo_path, _ = _generate_repo(repo_type, tmp_path)
+    repo_path, _ = _generate_repo(
+        repo_type, tmp_path, extra_context=_license_context(license_name)
+    )
     _run(repo_path, "python3", "-m", "venv", ".venv")
 
     _update_pyproject_repo_config_dep(
         repo_config_path=cwd, repo_type=repo_type, repo_path=repo_path
     )
 
+    env = os.environ.copy()
+    env["SETUPTOOLS_SCM_PRETEND_VERSION_FOR_FREQUENZ_REPO_CONFIG"] = "0.0.0"
     cmd = ". .venv/bin/activate; pip install .[dev-noxfile]; nox -e ci_checks_max pytest_min"
     print()
     print(f"Running in shell [{repo_path}]: {cmd}")
-    subprocess.run(cmd, shell=True, cwd=repo_path, check=True)
+    subprocess.run(cmd, shell=True, cwd=repo_path, check=True, env=env)
+
+
+@pytest.mark.integration
+@pytest.mark.cookiecutter
+@pytest.mark.parametrize(
+    ("repo_type", "license_name"),
+    [
+        *(
+            pytest.param(repo_type, "MIT", id=repo_type.value)
+            for repo_type in config.RepositoryType
+        ),
+        *(
+            pytest.param(
+                repo_type,
+                "Proprietary",
+                id=f"{repo_type.value}-proprietary",
+            )
+            for repo_type in config.RepositoryType
+        ),
+    ],
+)
+def test_golden(
+    tmp_path: pathlib.Path,
+    repo_type: config.RepositoryType,
+    license_name: str,
+    request: pytest.FixtureRequest,
+) -> None:
+    """Test generation of a new repo comparing it to a golden tree."""
+    _assert_golden_generation(
+        tmp_path,
+        repo_type,
+        request,
+        license_name=license_name,
+    )
+
+
+@pytest.mark.integration
+@pytest.mark.cookiecutter
+@pytest.mark.parametrize(
+    ("repo_type", "license_name"),
+    [
+        *(
+            pytest.param(repo_type, "MIT", id=repo_type.value)
+            for repo_type in config.RepositoryType
+        ),
+        pytest.param(
+            PROPRIETARY_TEST_REPO_TYPE,
+            "Proprietary",
+            id=f"{PROPRIETARY_TEST_REPO_TYPE.value}-proprietary",
+        ),
+    ],
+)
+def test_generation(
+    tmp_path: pathlib.Path,
+    repo_type: config.RepositoryType,
+    license_name: str,
+) -> None:
+    """Test generation of a new repo."""
+    _assert_generated_repo_checks(tmp_path, repo_type, license_name=license_name)
 
 
 def _generate_repo(
@@ -91,9 +180,14 @@ def _generate_repo(
     /,
     *,
     capture_output: bool = False,
+    extra_context: dict[str, str] | None = None,
     env: dict[str, str] | None = None,
 ) -> tuple[pathlib.Path, subprocess.CompletedProcess[bytes]]:
     cwd = pathlib.Path().cwd()
+    extra_args: list[str] = []
+    if extra_context:
+        extra_args.extend(f"{key}={value}" for key, value in extra_context.items())
+
     run_result = _run(
         tmp_path,
         "cookiecutter",
@@ -102,6 +196,7 @@ def _generate_repo(
         f"type={repo_type.value}",
         "name=test",
         "description=Test description",
+        *extra_args,
         capture_output=capture_output,
         env=env,
     )

tests_golden/integration/test_cookiecutter_generation/actor-proprietary/cookiecutter-stderr.txt

@@ -0,0 +1,56 @@
+./.github/ISSUE_TEMPLATE/bug.yml:        # TODO(cookiecutter): Add other parts
+./.github/ISSUE_TEMPLATE/config.yml:    # TODO(cookiecutter): Make sure the GitHub repository has a discussion category "Support"
+./.github/keylabeler.yml:  # TODO(cookiecutter): Add other parts
+./.github/labeler.yml:# TODO(cookiecutter): Add different parts of the source
+./CODEOWNERS:# TODO(cookiecutter): Add more specific code-owners, check if the default is correct
+./CODEOWNERS:* TODO(cookiecutter): Add codeowners (like @{github_org}/some-team)# Temporary, should probably change
+./README.md:TODO(cookiecutter): Improve the README file
+./mkdocs.yml:            # TODO(cookiecutter): You might want to add other external references here
+./mkdocs.yml:  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
+./mkdocs.yml:  # TODO(cookiecutter): You probably want to update the social links
+./mkdocs.yml:# TODO(cookiecutter): "v0.x.x" is the GitHub repo default branch, you might want to update it
+./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
+./src/frequenz/actor/test/__init__.py:# TODO(cookiecutter): Remove this function
+./src/frequenz/actor/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.
+./tests/test_test.py:def test_test_fails() -> None:  # TODO(cookiecutter): Remove
+./tests/test_test.py:def test_test_succeeds() -> None:  # TODO(cookiecutter): Remove
+
+--------------------------------------------------------------------------------
+
+Your 🍪 frequenz-actor-test has been cut!
+
+Here is a list of things that should be reviewed and FIXED:
+
+Make sure to (create and) configure your GitHub repository too: https://frequenz-floss.github.io/frequenz-repo-config-python/latest/user-guide/start-a-new-project/configure-github/
+
+After completing it you can amend the previous commit using `git commit --amend` or create a new commit for the changes using `git commit`.
+
+You can make sure linting and tests pass by creating a virtual environment, installing the development dependencies and running `nox`:
+
+cd frequenz-actor-test
+# Requires at least python version 3.11
+python3 -m venv .venv
+. .venv/bin/activate
+pip install .[dev-noxfile]
+nox
+
+To generate and serve the documentation:
+pip install .[dev-mkdocs]
+mkdocs serve
+
+To initialize the GitHub pages website:
+mike deploy --update-aliases v0.1-dev latest-dev latest
+mike set-default latest
+git push upstream gh-pages  # or origin if you haven't forked the repo
+
+Make sure that GitHub pages is enabled in your repository settings:
+https://github.com/frequenz-floss/frequenz-actor-test/settings/pages
+If all went well, your new website should be available soon at:
+https://frequenz-floss.github.io/frequenz-actor-test/
+
+WARNING: Using a non-MIT license with a frequenz-floss project is not recommended.
+
+If you had any issues or find any errors in the generated files, please report them!
+https://github.com/frequenz-floss/frequenz-repo-config-python/issues/new/choose

tests_golden/integration/test_cookiecutter_generation/actor-proprietary/cookiecutter-stdout.txt

@@ -0,0 +1,48 @@
+{
+  "cookiecutter": {
+    "Introduction": "",
+    "type": "actor",
+    "name": "test",
+    "description": "Test description",
+    "title": "Frequenz Test Actor",
+    "keywords": "(comma separated: 'frequenz', <type> and <name> are included automatically)",
+    "github_org": "frequenz-floss",
+    "license": "Proprietary",
+    "private_repo": "yes",
+    "author_name": "Frequenz Energy-as-a-Service GmbH",
+    "author_email": "floss@frequenz.com",
+    "python_package": "frequenz.actor.test",
+    "pypi_package_name": "frequenz-actor-test",
+    "github_repo_name": "frequenz-actor-test",
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
+  },
+  "_cookiecutter": {
+    "Introduction": "{{cookiecutter | introduction}}",
+    "type": [
+      "actor",
+      "api",
+      "app",
+      "lib",
+      "model"
+    ],
+    "name": "test",
+    "description": "Test description",
+    "title": "{{cookiecutter | proj_title}}",
+    "keywords": "(comma separated: 'frequenz', <type> and <name> are included automatically)",
+    "github_org": "frequenz-floss",
+    "license": [
+      "Proprietary",
+      "MIT"
+    ],
+    "private_repo": [
+      "{{ 'no' if cookiecutter.license == 'MIT' else 'yes' }}",
+      "{{ 'yes' if cookiecutter.license == 'MIT' else 'no' }}"
+    ],
+    "author_name": "Frequenz Energy-as-a-Service GmbH",
+    "author_email": "floss@frequenz.com",
+    "python_package": "{{cookiecutter | python_package}}",
+    "pypi_package_name": "{{cookiecutter | pypi_package_name}}",
+    "github_repo_name": "{{cookiecutter | github_repo_name}}",
+    "default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)"
+  }
+}

tests_golden/integration/test_cookiecutter_generation/actor-proprietary/frequenz-actor-test/.cookiecutter-replay.json

@@ -0,0 +1,26 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset, indent style and trimming of whitespace
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,md,proto,py,pyi,toml,yaml,yml}}]
+charset = utf-8
+indent_style = space
+trim_trailing_whitespace = true
+
+# 4 space indentation
+[*.{py,pyi}]
+indent_size = 4
+
+# 2 space indentation
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,proto,toml,yaml,yml}}]
+indent_size = 2
+
+# No indentation size specified for *.md because different blocks have
+# different indentation rules

tests_golden/integration/test_cookiecutter_generation/actor-proprietary/frequenz-actor-test/.editorconfig

@@ -0,0 +1,66 @@
+# GitHub issue form. For more information see:
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Report something is not working properly 🐛
+description:
+  Use this if there is something that is not working properly.  If you are not
+  sure or you need help making something work, please ask a question instead.
+labels:
+  - "priority:❓"
+  - "type:bug"
+body:
+  - type: markdown
+    attributes:
+      value:
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Please tell us what happened that shouldn't have.
+      placeholder: What happened that shouldn't have.
+    validations:
+      required: true
+  - type: textarea
+    id: what-expected
+    attributes:
+      label: What did you expect instead?
+      description: Please tell us what did you expect to happen.
+      placeholder: What did you expect to happen.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Affected version(s)
+      description:
+        Please add a comma-separated list of the versions affected by this
+        issue.
+      placeholder: 'Example: v0.11.0, v0.12.0'
+  - type: dropdown
+    id: part
+    attributes:
+      label: Affected part(s)
+      description:
+        Which parts of the repo are affected by this issue? Select all that
+        apply.
+      multiple: true
+      options:
+        - I don't know (part:❓)
+        - Documentation (part:docs)
+        - Unit, integration and performance tests (part:tests)
+        - Build script, CI, dependencies, etc. (part:tooling)
+        # TODO(cookiecutter): Add other parts
+        # Please have in mind that that the part:xxx labels need to
+        # be created in the GitHub repository.
+    validations:
+      required: true
+  - type: textarea
+    id: extra
+    attributes:
+      label: Extra information
+      description:
+        Please write here any extra information you think it might be relevant,
+        e.g., if this didn't happen before, or if you suspect where the problem
+        might be.
+      placeholder: Any extra information you think it might be relevant.

tests_golden/integration/test_cookiecutter_generation/actor-proprietary/frequenz-actor-test/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,10 @@
+# GitHub issue template chooser. For more information see:
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+
+blank_issues_enabled: true
+contact_links:
+  - name: Ask a question ❓
+    url: https://github.com/frequenz-floss/frequenz-actor-test/discussions/new?category=support
+    # TODO(cookiecutter): Make sure the GitHub repository has a discussion category "Support"
+    # Rename the "Q&A" category to "Support" and change the emoji to 🆘 (SOS)
+    about: Use this if you are not sure how to do something, have installation problems, etc.