Make sure name is converted to an identifier for files

If we still use `-` in files, things break, so we should always convert
the `name` to a valid identifier when using it in files.

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

Author: llucax

cookiecutter/cookiecutter.json

@@ -24,6 +24,7 @@
 	"default_codeowners": "(like @some-org/some-team; defaults to a team based on the repo type)",
 	"_extensions": [
 		"jinja2_time.TimeExtension",
+		"local_extensions.as_identifier",
 		"local_extensions.default_codeowners",
 		"local_extensions.github_repo_name",
 		"local_extensions.introduction",

cookiecutter/hooks/post_gen_project.py

@@ -451,9 +451,10 @@ def finish_lib_setup() -> None:
       - `lib`: `src/frequenz/{name}`
       - `rest`: `src/frequenz/{type}/{name}`
     """
+    name = cookiecutter.name.lower().replace("-", "_")
     recursive_overwrite_move(
-        _pathlib.Path(f"src/frequenz/{cookiecutter.type}/{cookiecutter.name}"),
-        _pathlib.Path(f"src/frequenz/{cookiecutter.name}"),
+        _pathlib.Path(f"src/frequenz/{cookiecutter.type}/{name}"),
+        _pathlib.Path(f"src/frequenz/{name}"),
     )
     _pathlib.Path(f"src/frequenz/{cookiecutter.type}").rmdir()
 

cookiecutter/local_extensions.py

@@ -47,6 +47,19 @@ def _get_from_json(key: str) -> str:
 
 
 # Ignoring because cookiecutter simple_filter decorator is not typed.
+@_simple_filter  # type: ignore[misc]
+def as_identifier(name: str) -> str:
+    """Convert a name to a valid identifier.
+
+    Args:
+        name: The name to convert.
+
+    Returns:
+        The converted identifier.
+    """
+    return name.lower().replace("-", "_")
+
+
 @_simple_filter  # type: ignore[misc]
 def python_package(cookiecutter: dict[str, str]) -> str:
     """Generate the Python package (import) depending on the repository type.

cookiecutter/{{cookiecutter.github_repo_name}}/.github/labeler.yml

@@ -10,10 +10,10 @@
 # For example:
 #
 # "part:module":
-#   - "src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name}}/module/**"
+#   - "src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name | as_identifier}}/module/**"
 #
 # "part:other":
-#   - "src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name}}/other/**"
+#   - "src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name | as_identifier}}/other/**"
 #
 # # For excluding some files (in this example, label "part:complicated"
 # # everything inside src/ with a .py suffix, except for src/__init__.py)

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

@@ -12,7 +12,7 @@
 
 syntax = "proto3";
 
-package frequenz.api.{{cookiecutter.name}}.{{cookiecutter.name}};
+package frequenz.api.{{cookiecutter.name | as_identifier}}.{{cookiecutter.name | as_identifier}};
 
 // An example message.
 //

cookiecutter/{{cookiecutter.github_repo_name}}/src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name}}/__init__.py renamed to cookiecutter/{{cookiecutter.github_repo_name}}/src/frequenz/{{cookiecutter.type}}/{{cookiecutter.name | as_identifier}}/__init__.py

@@ -1,42 +1,42 @@
 # License: {{cookiecutter.license}}
 # Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_name}}
 
-"""Tests for the {{cookiecutter.name}} package."""
+"""Tests for the {{cookiecutter.python_package}} package."""
 
 {%- if cookiecutter.type == "api" %}
 
 
 def test_package_import() -> None:
     """Test that the package can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api import {{cookiecutter.name}}
+    from frequenz.api import {{cookiecutter.name | as_identifier}}
 
-    assert {{cookiecutter.name}} is not None
+    assert {{cookiecutter.name | as_identifier}} is not None
 
 
 def test_module_import_components() -> None:
     """Test that the modules can be imported."""
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.{{cookiecutter.name}} import {{cookiecutter.name}}_pb2
+    from frequenz.api.{{cookiecutter.name | as_identifier}} import {{cookiecutter.name | as_identifier}}_pb2
 
-    assert {{cookiecutter.name}}_pb2 is not None
+    assert {{cookiecutter.name | as_identifier}}_pb2 is not None
 
     # pylint: disable=import-outside-toplevel
-    from frequenz.api.{{cookiecutter.name}} import {{cookiecutter.name}}_pb2_grpc
+    from frequenz.api.{{cookiecutter.name | as_identifier}} import {{cookiecutter.name | as_identifier}}_pb2_grpc
 
-    assert {{cookiecutter.name}}_pb2_grpc is not None
+    assert {{cookiecutter.name | as_identifier}}_pb2_grpc is not None
 {%- else %}
 import pytest
 
 from {{cookiecutter.python_package}} import delete_me
 
 
-def test_{{cookiecutter.name}}_succeeds() -> None:  # TODO(cookiecutter): Remove
+def test_{{cookiecutter.name | as_identifier}}_succeeds() -> None:  # TODO(cookiecutter): Remove
     """Test that the delete_me function succeeds."""
     assert delete_me() is True
 
 
-def test_{{cookiecutter.name}}_fails() -> None:  # TODO(cookiecutter): Remove
+def test_{{cookiecutter.name | as_identifier}}_fails() -> None:  # TODO(cookiecutter): Remove
     """Test that the delete_me function fails."""
     with pytest.raises(RuntimeError, match="This function should be removed!"):
         delete_me(blow_up=True)