[change] Releaser: defined a generic package type to use as fallback

The logic which detected OpenWrt packages has been generalized so that
any file which doesn't fall under well defined categories like "python package",
"npm package", "ansible role", etc., can fall under the "generic package" type,
as long as a VERSION file is defined in the top level directory of the repository,
the releaser tool will be able to deal with it, regardless of the tech stack used.

Author: pandafy

openwisp_utils/releaser/config.py

@@ -25,7 +25,9 @@ def get_package_type_from_setup():
         "package.json": "npm",
         "docker-compose.yml": "docker",
         ".ansible-lint": "ansible",
-        ".luacheckrc": "openwrt",
+        # The VERSION file check should be last to avoid false positives
+        # with other package types
+        "VERSION": "generic",
     }
     for filename, package_type in package_type_files.items():
         if os.path.exists(filename):
@@ -50,24 +52,33 @@ def detect_changelog_style(changelog_path):
 
 
 def _handle_python_version(config):
-    """Handles version detection for Python packages."""
+    """Handles version detection for Python packages.
+
+    Checks __init__.py first, then falls back to version.py (eg:
+    netjsonconfig, netdiff).
+    """
     project_name = get_package_name_from_setup()
     if not project_name:
         return
     package_directory = project_name.replace("-", "_")
-    init_py_path = os.path.join(package_directory, "__init__.py")
-    if not os.path.exists(init_py_path):
-        return
-    with open(init_py_path, "r") as f:
-        content = f.read()
-        version_match = re.search(r"^VERSION\s*=\s*\((.*)\)", content, re.M)
-        if version_match:
-            config["version_path"] = init_py_path
-            try:
-                version_tuple = ast.literal_eval(f"({version_match.group(1)})")
-                config["CURRENT_VERSION"] = list(version_tuple)
-            except (ValueError, SyntaxError):
-                config["CURRENT_VERSION"] = None
+    candidate_files = [
+        os.path.join(package_directory, "__init__.py"),
+        os.path.join(package_directory, "version.py"),
+    ]
+    for version_path in candidate_files:
+        if not os.path.exists(version_path):
+            continue
+        with open(version_path, "r") as f:
+            content = f.read()
+            version_match = re.search(r"^VERSION\s*=\s*\((.*)\)", content, re.M)
+            if version_match:
+                config["version_path"] = version_path
+                try:
+                    version_tuple = ast.literal_eval(f"({version_match.group(1)})")
+                    config["CURRENT_VERSION"] = list(version_tuple)
+                except (ValueError, SyntaxError, TypeError):
+                    config["CURRENT_VERSION"] = None
+                return
 
 
 def _handle_npm_version(config):
@@ -166,10 +177,8 @@ def _handle_ansible_version(config):
             config["CURRENT_VERSION"] = None
 
 
-def _handle_openwrt_version(config):
-    """Handles version detection for OpenWRT packages."""
-    if not os.path.exists("VERSION"):
-        return
+def _handle_generic_version(config):
+    """Handles version detection for packages using a root VERSION file."""
     with open("VERSION", "r") as f:
         version_str = f.read().strip()
         if not version_str:
@@ -197,7 +206,7 @@ def _handle_openwrt_version(config):
     "npm": _handle_npm_version,
     "docker": _handle_docker_version,
     "ansible": _handle_ansible_version,
-    "openwrt": _handle_openwrt_version,
+    "generic": _handle_generic_version,
 }
 
 

openwisp_utils/releaser/tests/conftest.py

@@ -41,6 +41,24 @@ def create_package_dir_with_version():
     return _create_package_dir_with_version
 
 
+def _create_package_dir_with_version_in_version_py(
+    path: Path, name="my-test-package", version_str="VERSION = (1, 2, 3, 'final')"
+):
+    """Create a package using the netjsonconfig/netdiff version layout.
+
+    Unlike the standard layout, the VERSION tuple is defined in
+    ``version.py`` instead of ``__init__.py``.
+    """
+    pkg_dir = path / name.replace("-", "_")
+    pkg_dir.mkdir(exist_ok=True)
+    (pkg_dir / "version.py").write_text(version_str)
+
+
+@pytest.fixture
+def create_package_dir_with_version_in_version_py():
+    return _create_package_dir_with_version_in_version_py
+
+
 def _create_changelog(path: Path, ext="rst"):
     (path / f"CHANGES.{ext}").write_text("Changelog")
 
@@ -113,6 +131,16 @@ def create_ansible_lint():
     return _create_ansible_lint
 
 
+def _create_luacheckrc(path: Path):
+    """Helper to create .luacheckrc file."""
+    (path / ".luacheckrc").write_text("std = 'min'")
+
+
+@pytest.fixture
+def create_luacheckrc():
+    return _create_luacheckrc
+
+
 def _create_ansible_version_file(path: Path, version="1.2.3"):
     """Helper to create templates/openwisp2/version.py for ansible projects."""
     templates_dir = path / "templates" / "openwisp2"
@@ -125,18 +153,8 @@ def create_ansible_version_file():
     return _create_ansible_version_file
 
 
-def _create_luacheckrc(path: Path):
-    """Helper to create .luacheckrc file for OpenWRT agents."""
-    (path / ".luacheckrc").write_text("std = 'min'")
-
-
-@pytest.fixture
-def create_luacheckrc():
-    return _create_luacheckrc
-
-
 def _create_version_file(path: Path, version="1.2.3"):
-    """Helper to create VERSION file for OpenWRT agents."""
+    """Helper to create VERSION file for generic package type."""
     (path / "VERSION").write_text(version)
 
 

openwisp_utils/releaser/tests/test_config.py

@@ -169,6 +169,84 @@ def test_config_malformed_version_literal_eval_fails(
     assert config["CURRENT_VERSION"] is None
 
 
+def test_config_version_non_iterable_type_error(
+    project_dir, create_setup_py, create_package_dir_with_version, create_changelog
+):
+    """Tests that TypeError is caught when version tuple is non-iterable.
+
+    For example, VERSION = (1) evaluates to an integer, and list(1) raises
+    TypeError.
+    """
+    create_setup_py(project_dir)
+    create_package_dir_with_version(project_dir, version_str="VERSION = (1)")
+    create_changelog(project_dir)
+    config = load_config()
+    # Should gracefully handle the TypeError and return None
+    assert config["CURRENT_VERSION"] is None
+
+
+def test_python_version_detection_from_version_py_for_netjsonconfig_compatibility(
+    project_dir,
+    create_setup_py,
+    create_package_dir_with_version_in_version_py,
+    create_changelog,
+    init_git_repo,
+):
+    """Ensure version detection supports the netjsonconfig/netdiff layout.
+
+    These projects define VERSION in ``version.py`` rather than in
+    ``__init__.py``, which differs from the standard project layout.
+    """
+    create_setup_py(project_dir)
+    create_package_dir_with_version_in_version_py(project_dir)
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "python"
+    assert config["version_path"] == "my_test_package/version.py"
+    assert config["CURRENT_VERSION"] == [1, 2, 3, "final"]
+
+
+def test_python_version_ignores_version_py_when_init_py_defines_version(
+    project_dir,
+    create_setup_py,
+    create_package_dir_with_version,
+    create_changelog,
+    init_git_repo,
+):
+    create_setup_py(project_dir)
+    # Create both __init__.py and version.py with VERSION
+    pkg_dir = project_dir / "my_test_package"
+    pkg_dir.mkdir(exist_ok=True)
+    (pkg_dir / "__init__.py").write_text("VERSION = (1, 0, 0, 'final')")
+    (pkg_dir / "version.py").write_text("VERSION = (2, 0, 0, 'final')")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "python"
+    assert config["version_path"] == "my_test_package/__init__.py"
+    assert config["CURRENT_VERSION"] == [1, 0, 0, "final"]
+
+
+def test_python_version_detection_for_netjsonconfig_when_init_py_lacks_version(
+    project_dir,
+    create_setup_py,
+    create_changelog,
+    init_git_repo,
+):
+    create_setup_py(project_dir)
+    pkg_dir = project_dir / "my_test_package"
+    pkg_dir.mkdir(exist_ok=True)
+    (pkg_dir / "__init__.py").write_text("# No version here\n")
+    (pkg_dir / "version.py").write_text("VERSION = (3, 4, 5, 'final')")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "python"
+    assert config["version_path"] == "my_test_package/version.py"
+    assert config["CURRENT_VERSION"] == [3, 4, 5, "final"]
+
+
 # NPM Package Tests
 def test_npm_package_detection(
     project_dir, create_package_json, create_changelog, init_git_repo
@@ -354,45 +432,130 @@ def test_ansible_package_malformed_version(
     assert config["CURRENT_VERSION"] is None
 
 
-# OpenWRT Package Tests
-def test_openwrt_package_detection(
-    project_dir, create_luacheckrc, create_version_file, create_changelog, init_git_repo
+# Generic Package Tests
+def test_generic_package_detection(
+    project_dir, create_version_file, create_changelog, init_git_repo
 ):
-    """Tests that openwrt package type is detected when .luacheckrc exists."""
-    create_luacheckrc(project_dir)
+    """Tests that generic package type is detected when VERSION file exists."""
     create_version_file(project_dir, version="1.2.3")
     create_changelog(project_dir)
     init_git_repo(project_dir)
     config = load_config()
-    assert config["package_type"] == "openwrt"
+    assert config["package_type"] == "generic"
     assert config["version_path"] == "VERSION"
     assert config["CURRENT_VERSION"] == [1, 2, 3, "final"]
 
 
-def test_openwrt_without_version_file(
-    project_dir, create_luacheckrc, create_changelog, init_git_repo
+def test_generic_fallback_without_other_config(
+    project_dir, create_version_file, create_changelog, init_git_repo
 ):
-    """Tests openwrt package without VERSION file."""
-    create_luacheckrc(project_dir)
+    """Tests that VERSION file is used as fallback when no other package type is detected."""
+    create_version_file(project_dir, version="2.0.1")
     create_changelog(project_dir)
     init_git_repo(project_dir)
     config = load_config()
-    assert config["package_type"] == "openwrt"
-    assert config["version_path"] is None
+    assert config["package_type"] == "generic"
+    assert config["version_path"] == "VERSION"
+    assert config["CURRENT_VERSION"] == [2, 0, 1, "final"]
+
+
+def test_generic_invalid_version(
+    project_dir, create_version_file, create_changelog, init_git_repo
+):
+    """Tests generic package with invalid version format gracefully."""
+    create_version_file(project_dir, version="1.2")  # Invalid: only 2 parts
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "generic"
+    assert config["version_path"] == "VERSION"
     assert config["CURRENT_VERSION"] is None
 
 
-def test_openwrt_invalid_version(
+def test_generic_not_fallback_when_other_type_detected(
+    project_dir,
+    create_setup_py,
+    create_package_dir_with_version,
+    create_version_file,
+    create_changelog,
+    init_git_repo,
+):
+    """Tests that VERSION file is not used as fallback when another package type is detected."""
+    create_setup_py(project_dir)
+    create_package_dir_with_version(project_dir)
+    create_version_file(project_dir, version="1.2.3")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "python"
+    assert config["version_path"] == "my_test_package/__init__.py"
+
+
+def test_generic_not_fallback_when_npm_detected(
+    project_dir,
+    create_package_json,
+    create_version_file,
+    create_changelog,
+    init_git_repo,
+):
+    """Tests that VERSION file is not used as fallback when npm package is detected."""
+    create_package_json(project_dir, version="1.2.3")
+    create_version_file(project_dir, version="1.5.0")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "npm"
+    assert config["version_path"] == "package.json"
+
+
+def test_generic_not_fallback_when_docker_detected(
+    project_dir,
+    create_docker_compose,
+    create_docker_version_file,
+    create_version_file,
+    create_changelog,
+    init_git_repo,
+):
+    """Tests that VERSION file is not used as fallback when docker package is detected."""
+    create_docker_compose(project_dir)
+    create_docker_version_file(project_dir, version="1.2.3")
+    create_version_file(project_dir, version="1.5.0")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "docker"
+    assert config["version_path"] == DOCKER_VERSION_PATH
+
+
+def test_generic_not_fallback_when_ansible_detected(
+    project_dir,
+    create_ansible_lint,
+    create_ansible_version_file,
+    create_version_file,
+    create_changelog,
+    init_git_repo,
+):
+    """Tests that VERSION file is not used as fallback when ansible package is detected."""
+    create_ansible_lint(project_dir)
+    create_ansible_version_file(project_dir, version="1.2.3")
+    create_version_file(project_dir, version="1.5.0")
+    create_changelog(project_dir)
+    init_git_repo(project_dir)
+    config = load_config()
+    assert config["package_type"] == "ansible"
+    assert config["version_path"] == "templates/openwisp2/version.py"
+
+
+def test_luacheckrc_does_not_trigger_detection(
     project_dir, create_luacheckrc, create_changelog, init_git_repo
 ):
-    """Tests openwrt package with invalid version format gracefully."""
+    """Tests that .luacheckrc alone does not trigger any package type detection."""
     create_luacheckrc(project_dir)
-    (project_dir / "VERSION").write_text("1.2")  # Invalid: only 2 parts
     create_changelog(project_dir)
     init_git_repo(project_dir)
     config = load_config()
-    assert config["package_type"] == "openwrt"
-    assert config["version_path"] == "VERSION"
+    assert config["package_type"] is None
+    assert config["version_path"] is None
     assert config["CURRENT_VERSION"] is None