App Version: {{ app_version }}
+App Version: {{ app_version }}{% if release_name %} "{{ release_name }}"{% endif %}
Build Date: {{ build_date }}
Debug Mode: {{ "Enabled" if debug_enabled else "Disabled" }}
{% if last_check %} diff --git a/release_names.json b/release_names.json new file mode 100644 index 00000000..2eeb6e20 --- /dev/null +++ b/release_names.json @@ -0,0 +1,36 @@ +{ + "_description": "Maps version patterns to release codenames. Used by the application at runtime and in build metadata.", + "_format": "Each key is a version string (e.g., '0.5.0') or a minor version prefix (e.g., '0.5'). The value is an object with 'codename' and optionally 'description' and 'milestone'.", + "releases": { + "0.5": { + "codename": "Foundation", + "description": "Core platform with multi-provider storage, AI extraction, and web UI", + "milestone": "v0.5.0 - Core Platform" + }, + "0.6": { + "codename": "Clarity", + "description": "Enhanced search, filtering, and improved UI/UX", + "milestone": "v0.6.0 - Search & UX" + }, + "0.7": { + "codename": "Conductor", + "description": "Workflow automation, custom pipelines, and rule-based processing", + "milestone": "v0.7.0 - Workflow Automation" + }, + "1.0": { + "codename": "Summit", + "description": "Enterprise-ready with multi-tenancy, RBAC, and horizontal scaling", + "milestone": "v1.0.0 - Enterprise" + }, + "1.1": { + "codename": "Bridge", + "description": "Collaboration features, document sharing, and analytics", + "milestone": "v1.1.0 - Collaboration" + }, + "2.0": { + "codename": "Horizon", + "description": "On-premise AI, advanced document management, and platform expansion", + "milestone": "v2.0.0 - Next Generation" + } + } +} diff --git a/scripts/generate_build_metadata.sh b/scripts/generate_build_metadata.sh index 6639b57e..06a0dd4d 100755 --- a/scripts/generate_build_metadata.sh +++ b/scripts/generate_build_metadata.sh @@ -68,19 +68,54 @@ else VERSION="unknown" fi +# Look up release codename from release_names.json +RELEASE_NAME="" +if [ -f "release_names.json" ] && command -v python3 > /dev/null 2>&1; then + MINOR_PREFIX=$(echo "${VERSION}" | cut -d. -f1-2) + RELEASE_NAME=$(python3 -c " +import json, sys +try: + with open('release_names.json') as f: + data = json.load(f) + releases = data.get('releases', {}) + version = '${VERSION}' + minor = '${MINOR_PREFIX}' + codename = None + if version in releases: + codename = releases[version].get('codename') + elif minor in releases: + codename = releases[minor].get('codename') + if codename: + print(codename) +except Exception: + pass +" 2>/dev/null || true) +fi + +if [ -n "${RELEASE_NAME}" ]; then + echo "✓ Release Name: ${RELEASE_NAME}" +fi + # Generate RUNTIME_INFO with combined metadata -cat > RUNTIME_INFO << EOF -DocuElevate Build Information +RUNTIME_INFO_CONTENT="DocuElevate Build Information ============================== Version: ${VERSION} Build Date: ${BUILD_DATE} Git Commit: ${GIT_FULL_SHA} Git Short SHA: ${GIT_SHA} Git Branch: ${GIT_BRANCH} -Commit Date: ${GIT_COMMIT_DATE} +Commit Date: ${GIT_COMMIT_DATE}" + +if [ -n "${RELEASE_NAME}" ]; then + RUNTIME_INFO_CONTENT="${RUNTIME_INFO_CONTENT} +Release Name: ${RELEASE_NAME}" +fi + +RUNTIME_INFO_CONTENT="${RUNTIME_INFO_CONTENT} Build Timestamp: $(date -u '+%Y-%m-%dT%H:%M:%SZ') -============================== -EOF +==============================" + +echo "${RUNTIME_INFO_CONTENT}" > RUNTIME_INFO echo "✓ RUNTIME_INFO generated" echo "" diff --git a/tests/test_release_names.py b/tests/test_release_names.py new file mode 100644 index 00000000..04cb3a0f --- /dev/null +++ b/tests/test_release_names.py @@ -0,0 +1,267 @@ +"""Tests for release naming functionality in app/config.py and app/views/status.py.""" + +import json +import os +from unittest.mock import Mock, patch + +import pytest + + +@pytest.mark.unit +class TestReleaseNameProperty: + """Tests for the Settings.release_name property.""" + + def test_release_name_returns_codename_for_minor_prefix(self, tmp_path): + """Test release_name returns codename matching minor version prefix.""" + release_data = { + "releases": { + "0.5": {"codename": "Foundation", "description": "Core platform"}, + } + } + release_file = tmp_path / "release_names.json" + release_file.write_text(json.dumps(release_data)) + + with ( + patch("app.config.Settings.version", new_callable=lambda: property(lambda self: "0.5.3")), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + from app.config import Settings + + s = Settings.__new__(Settings) + # Directly call the property with mocked file path + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.5.3")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result == "Foundation" + + def test_release_name_returns_codename_for_exact_match(self, tmp_path): + """Test release_name returns codename for exact version match.""" + release_data = { + "releases": { + "1.0.0": {"codename": "Summit"}, + } + } + release_file = tmp_path / "release_names.json" + release_file.write_text(json.dumps(release_data)) + + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "1.0.0")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result == "Summit" + + def test_release_name_returns_none_when_no_match(self, tmp_path): + """Test release_name returns None when version has no codename.""" + release_data = { + "releases": { + "0.5": {"codename": "Foundation"}, + } + } + release_file = tmp_path / "release_names.json" + release_file.write_text(json.dumps(release_data)) + + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.9.1")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result is None + + def test_release_name_returns_none_when_file_missing(self): + """Test release_name returns None when release_names.json doesn't exist.""" + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.5.0")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value="/nonexistent/release_names.json"), + patch("app.config.os.path.exists", return_value=False), + ): + result = s.release_name + assert result is None + + def test_release_name_returns_none_for_unknown_version(self): + """Test release_name returns None when version is 'unknown'.""" + from app.config import Settings + + s = Settings.__new__(Settings) + with patch.object(type(s), "version", new_callable=lambda: property(lambda self: "unknown")): + result = s.release_name + assert result is None + + def test_release_name_returns_none_for_empty_version(self): + """Test release_name returns None when version is empty.""" + from app.config import Settings + + s = Settings.__new__(Settings) + with patch.object(type(s), "version", new_callable=lambda: property(lambda self: "")): + result = s.release_name + assert result is None + + def test_release_name_handles_invalid_json(self, tmp_path): + """Test release_name handles corrupt JSON gracefully.""" + release_file = tmp_path / "release_names.json" + release_file.write_text("{invalid json") + + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.5.0")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result is None + + def test_release_name_handles_missing_releases_key(self, tmp_path): + """Test release_name handles JSON without 'releases' key.""" + release_file = tmp_path / "release_names.json" + release_file.write_text(json.dumps({"something_else": {}})) + + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.5.0")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result is None + + def test_release_name_prefers_exact_over_minor(self, tmp_path): + """Test release_name prefers exact version match over minor prefix.""" + release_data = { + "releases": { + "0.5.0": {"codename": "ExactMatch"}, + "0.5": {"codename": "MinorMatch"}, + } + } + release_file = tmp_path / "release_names.json" + release_file.write_text(json.dumps(release_data)) + + from app.config import Settings + + s = Settings.__new__(Settings) + with ( + patch.object(type(s), "version", new_callable=lambda: property(lambda self: "0.5.0")), + patch("app.config.os.path.dirname"), + patch("app.config.os.path.join", return_value=str(release_file)), + patch("app.config.os.path.exists", return_value=True), + ): + result = s.release_name + assert result == "ExactMatch" + + +@pytest.mark.unit +class TestReleaseNameInStatusView: + """Tests for release name display in status dashboard.""" + + @patch("app.views.status.get_provider_status") + @patch("app.views.status.templates") + @patch("app.views.status.settings") + @patch("app.views.status.os.path.exists") + @pytest.mark.asyncio + async def test_status_dashboard_includes_release_name( + self, mock_exists, mock_settings, mock_templates, mock_providers + ): + """Test status dashboard passes release_name to template context.""" + from app.views.status import status_dashboard + + mock_exists.return_value = False + mock_providers.return_value = {} + mock_settings.version = "0.5.3" + mock_settings.build_date = "2024-01-01" + mock_settings.debug = False + mock_settings.git_sha = "abc123" + mock_settings.notification_urls = [] + mock_settings.release_name = "Foundation" + + mock_request = Mock() + await status_dashboard(mock_request) + + call_args = mock_templates.TemplateResponse.call_args + context = call_args[0][1] + assert context["release_name"] == "Foundation" + + @patch("app.views.status.get_provider_status") + @patch("app.views.status.templates") + @patch("app.views.status.settings") + @patch("app.views.status.os.path.exists") + @pytest.mark.asyncio + async def test_status_dashboard_handles_missing_release_name( + self, mock_exists, mock_settings, mock_templates, mock_providers + ): + """Test status dashboard handles missing release_name attribute gracefully.""" + from app.views.status import status_dashboard + + mock_exists.return_value = False + mock_providers.return_value = {} + mock_settings.version = "0.9.0" + mock_settings.build_date = "2024-01-01" + mock_settings.debug = False + mock_settings.git_sha = "abc123" + mock_settings.notification_urls = [] + # Simulate settings without release_name attribute + del mock_settings.release_name + + mock_request = Mock() + await status_dashboard(mock_request) + + call_args = mock_templates.TemplateResponse.call_args + context = call_args[0][1] + assert context["release_name"] is None + + +@pytest.mark.unit +class TestReleaseNamesJson: + """Tests for the release_names.json data file.""" + + def test_release_names_json_is_valid(self): + """Test that release_names.json is valid JSON.""" + release_file = os.path.join(os.path.dirname(os.path.dirname(__file__)), "release_names.json") + with open(release_file, "r") as f: + data = json.load(f) + + assert "releases" in data + assert isinstance(data["releases"], dict) + + def test_release_names_json_entries_have_codename(self): + """Test that all entries in release_names.json have a codename.""" + release_file = os.path.join(os.path.dirname(os.path.dirname(__file__)), "release_names.json") + with open(release_file, "r") as f: + data = json.load(f) + + for version, entry in data["releases"].items(): + assert "codename" in entry, f"Missing codename for version {version}" + assert isinstance(entry["codename"], str), f"Codename for {version} must be a string" + assert len(entry["codename"]) > 0, f"Codename for {version} must not be empty" + + def test_release_names_json_codenames_are_unique(self): + """Test that all codenames in release_names.json are unique.""" + release_file = os.path.join(os.path.dirname(os.path.dirname(__file__)), "release_names.json") + with open(release_file, "r") as f: + data = json.load(f) + + codenames = [entry["codename"] for entry in data["releases"].values()] + assert len(codenames) == len(set(codenames)), "Codenames must be unique"