Make copyright year fakable in golden tests (#212)

We need this to avoid having golden tests fail when the year changes.

Happy new year, everyone!

Author: leandro-lucarella-frequenz

cookiecutter/local_extensions.py

@@ -7,6 +7,7 @@
 project structure.
 """
 
+import datetime as _datetime
 import json as _json
 import os as _os
 import pathlib as _pathlib
@@ -40,6 +41,7 @@ def __init__(self, environment: _Environment):
         self.environment.globals.update(
             {
                 "random_weekday": self._get_random_weekday(),
+                "copyright_year": str(self._get_copyright_year()),
             }
         )
 
@@ -90,6 +92,14 @@ def _build_identifier(self, repo_type: str, name: str, separator: str) -> str:
         middle = f"{repo_type}{separator}" if repo_type != "lib" else ""
         return f"frequenz{separator}{middle}{name}"
 
+    def _is_golden_testing(self) -> bool:
+        """Return `True` if we are running as part of a golden testing.
+
+        Returns:
+            Whether we are running as part of a golden testing.
+        """
+        return _os.environ.get("GOLDEN_TEST", None) is not None
+
     def _get_from_json(self, key: str) -> str:
         """Get a string from the cookiecutter.json file.
 
@@ -109,7 +119,7 @@ def _get_random_weekday(self) -> str:
             A random weekday.
         """
         # Make sure tests are reproduceable
-        if _os.environ.get("PYTEST_CURRENT_TEST") is not None:
+        if self._is_golden_testing():
             return "monday"
         return _random.choice(
             [
@@ -123,6 +133,19 @@ def _get_random_weekday(self) -> str:
             ]
         )
 
+    def _get_copyright_year(self) -> int:
+        """Get the copyright year.
+
+        This will be faked when running the golden tests to make sure the tests are
+        reproduceable.
+
+        Returns:
+            The copyright year.
+        """
+        if self._is_golden_testing():
+            return 2023
+        return _datetime.datetime.now().year
+
     def _as_identifier_filter(self, name: str) -> str:
         """Convert a name to a valid identifier.
 

cookiecutter/{{cookiecutter.github_repo_name}}/.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -1,5 +1,5 @@
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 {% raw -%}
 
 # This Dockerfile is used to run the tests in arm64, which is not supported by

cookiecutter/{{cookiecutter.github_repo_name}}/.github/containers/nox-cross-arch/entrypoint.bash

@@ -1,6 +1,6 @@
 #!/bin/bash
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 {% raw -%}
 set -e
 

cookiecutter/{{cookiecutter.github_repo_name}}/.github/containers/test-installation/Dockerfile

@@ -1,5 +1,5 @@
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 {% raw -%}
 
 # This Dockerfile is used to test the installation of the python package in

cookiecutter/{{cookiecutter.github_repo_name}}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cookiecutter/{{cookiecutter.github_repo_name}}/docs/_scripts/macros.py

@@ -1,5 +1,5 @@
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 
 """This module defines macros for use in Markdown files."""
 

cookiecutter/{{cookiecutter.github_repo_name}}/docs/_scripts/mkdocstrings_autoapi.py

@@ -1,5 +1,5 @@
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 
 """Generate the code reference pages."""
 

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

@@ -5,7 +5,7 @@
 site_name: "{{cookiecutter.title}}"
 site_description: "{{cookiecutter.description}}"
 site_author: "{{cookiecutter.author_name}}"
-copyright: "Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}"
+copyright: "Copyright © {{copyright_year}} {{cookiecutter.author_name}}"
 repo_name: "{{cookiecutter.github_repo_name}}"
 repo_url: "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}"
 # TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it

cookiecutter/{{cookiecutter.github_repo_name}}/noxfile.py

@@ -1,5 +1,5 @@
 # License: {{cookiecutter.license}}
-# Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+# Copyright © {{copyright_year}} {{cookiecutter.author_name}}
 
 """Configuration file for nox."""
 

cookiecutter/{{cookiecutter.github_repo_name}}/proto/frequenz/api/{{cookiecutter.name | as_identifier}}/{{cookiecutter.name | as_identifier}}.proto

@@ -5,7 +5,7 @@
 // TODO(cookiecutter): Add a more descriptive package description.
 //
 // Copyright:
-// Copyright {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
+// Copyright {{copyright_year}} {{cookiecutter.author_name}}
 //
 // License:
 // {{cookiecutter.license}}