daktari 0.0.300__tar.gz → 0.0.306__tar.gz

{daktari-0.0.300/daktari.egg-info → daktari-0.0.306}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daktari
-Version: 0.0.300
+Version: 0.0.306
 Summary: Assist in setting up and maintaining developer environments
 Author-email: Matt Russell <matthew.russell@sonocent.com>
 License: Copyright 2021 Sonocent Ltd
@@ -18,8 +18,8 @@ Requires-Dist: ansicolors==1.1.8
 Requires-Dist: distro==1.9.0
 Requires-Dist: pyfiglet==1.0.4
 Requires-Dist: importlib_resources==6.5.2
-Requires-Dist: packaging==25.0
-Requires-Dist: setuptools==80.9.0
+Requires-Dist: packaging==26.0
+Requires-Dist: setuptools==80.10.2
 Requires-Dist: requests==2.32.5
 Requires-Dist: responses==0.25.8
 Requires-Dist: semver==3.0.4
@@ -33,7 +33,7 @@ Requires-Dist: dpath==2.2.0
 Requires-Dist: pyOpenSSL==25.3.0
 Requires-Dist: types-pyOpenSSL==24.1.0.20240722
 Requires-Dist: pyclip==0.7.0
-Requires-Dist: urllib3==2.6.2
+Requires-Dist: urllib3==2.6.3
 Dynamic: license-file
 
 **Daktari** is a tool to help the initial setup and ongoing maintenance of developer environments. It runs a series of checks (for example, that required software is installed) and provides suggestions on how to fix the issue if the check fails.
@@ -45,7 +45,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.300"
+version = "0.0.306"
 title = "My Project"
 
 checks = [

{daktari-0.0.300 → daktari-0.0.306}/README.md

@@ -7,7 +7,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.300"
+version = "0.0.306"
 title = "My Project"
 
 checks = [

daktari-0.0.306/daktari/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.306"

daktari-0.0.306/daktari/checks/npmrc.py

@@ -0,0 +1,126 @@
+import logging
+import os
+from dataclasses import dataclass
+from typing import List, Optional
+from urllib.parse import urlparse
+
+from daktari.check import Check, CheckResult
+from daktari.command_utils import can_run_command
+from daktari.file_utils import file_exists
+from daktari.os import OS
+
+PLACEHOLDER_TOKEN = "UPDATE_WITH_TOKEN"
+
+
+@dataclass
+class NpmrcScope:
+    name: str
+    registry: str
+    require_auth_token: bool = False
+
+
+def get_npmrc_path() -> str:
+    return os.path.expanduser("~/.npmrc")
+
+
+def get_npmrc_contents() -> List[str]:
+    npmrc_path = get_npmrc_path()
+    if not file_exists(npmrc_path):
+        raise Exception(f"{npmrc_path} does not exist")
+
+    try:
+        with open(npmrc_path, "r") as npmrc_file:
+            return npmrc_file.readlines()
+    except Exception:
+        logging.error(f"Exception reading {npmrc_path}", exc_info=True)
+        raise Exception("Failed to read npmrc")
+
+
+def get_registry_host(registry_url: str) -> str:
+    parsed = urlparse(registry_url)
+    return parsed.netloc
+
+
+def npmrc_contains_scope_registry(lines: List[str], scope: NpmrcScope) -> bool:
+    expected_line = f"@{scope.name}:registry={scope.registry}"
+    for line in lines:
+        if line.strip() == expected_line:
+            return True
+    return False
+
+
+def npmrc_contains_auth_token(lines: List[str], registry_url: str) -> bool:
+    host = get_registry_host(registry_url)
+    auth_token_prefix = f"//{host}/:_authToken="
+    for line in lines:
+        stripped = line.strip()
+        if stripped.startswith(auth_token_prefix):
+            token_value = stripped[len(auth_token_prefix) :]
+            if token_value and token_value != PLACEHOLDER_TOKEN:
+                return True
+    return False
+
+
+def npmrc_scope_is_configured(lines: List[str], scope: NpmrcScope) -> bool:
+    if not npmrc_contains_scope_registry(lines, scope):
+        return False
+    if scope.require_auth_token and not npmrc_contains_auth_token(lines, scope.registry):
+        return False
+    return True
+
+
+def get_npmrc_suggestion(scope: NpmrcScope) -> str:
+    lines = [f"@{scope.name}:registry={scope.registry}"]
+    if scope.require_auth_token:
+        host = get_registry_host(scope.registry)
+        lines.append(f"//{host}/:_authToken={PLACEHOLDER_TOKEN}")
+    return "\n".join(lines)
+
+
+class NpmrcScopeConfigured(Check):
+    name = "npmrc.scopeConfigured"
+
+    def __init__(self, scope: NpmrcScope, token_instructions: Optional[str] = None):
+        self.scope = scope
+        self.npmrc_suggestion = get_npmrc_suggestion(scope)
+        token_instruction_string = f"\n\n{token_instructions}" if token_instructions else ""
+        self.suggestions = {
+            OS.GENERIC: f"""Add the lines below to ~/.npmrc:
+
+{self.npmrc_suggestion}{token_instruction_string}"""
+        }
+
+    def check(self) -> CheckResult:
+        try:
+            lines = get_npmrc_contents()
+        except Exception as e:
+            return self.failed(str(e))
+
+        if not npmrc_scope_is_configured(lines, self.scope):
+            return self.failed(f"Scope {self.scope.name} not configured in npmrc")
+
+        return self.passed(f"Scope {self.scope.name} configured in npmrc")
+
+
+class NpmrcGithubTokenValid(Check):
+    name = "npmrc.githubTokenValid"
+    depends_on = [NpmrcScopeConfigured]
+
+    def __init__(self, scope_name: str, test_package: str):
+        self.scope_name = scope_name
+        self.test_package = test_package
+        self.suggestions = {
+            OS.GENERIC: "Please check the token was copied correctly from GitHub."
+            " Ensure the token hasn't expired, or has been revoked."
+            " Also, ensure it has the correct permissions to read packages."
+        }
+
+    def check(self) -> CheckResult:
+        package_spec = f"@{self.scope_name}/{self.test_package}"
+        command = f"npm view {package_spec} version"
+        logging.debug(f"Checking npm registry access with: {command}")
+
+        if can_run_command(command):
+            return self.passed(f"GitHub npm token is valid (can access {package_spec})")
+        else:
+            return self.failed(f"GitHub npm token is not valid (cannot access {package_spec})")

daktari-0.0.306/daktari/checks/pnpm.py

@@ -0,0 +1,14 @@
+from daktari.check import Check, CheckResult
+from daktari.os import OS
+
+
+class PnpmInstalled(Check):
+    name = "pnpm.installed"
+
+    suggestions = {
+        OS.OS_X: "<cmd>brew install pnpm</cmd>",
+        OS.GENERIC: "<cmd>npm install -g pnpm</cmd>",
+    }
+
+    def check(self) -> CheckResult:
+        return self.verify_install("pnpm")

daktari-0.0.306/daktari/checks/test_npmrc.py

@@ -0,0 +1,161 @@
+import unittest
+from unittest import mock
+
+from daktari.check import CheckStatus
+from daktari.checks.npmrc import (
+    NpmrcScope,
+    NpmrcScopeConfigured,
+    NpmrcGithubTokenValid,
+    get_registry_host,
+    npmrc_contains_scope_registry,
+    npmrc_contains_auth_token,
+    npmrc_scope_is_configured,
+    get_npmrc_suggestion,
+)
+
+TEST_SCOPE_NAME = "my-org"
+TEST_REGISTRY = "https://npm.pkg.github.com"
+TEST_REGISTRY_HOST = "npm.pkg.github.com"
+TEST_AUTH_TOKEN = "ghp_abc123xyz"
+
+
+class TestNpmrcHelpers(unittest.TestCase):
+    def test_get_registry_host(self):
+        self.assertEqual(get_registry_host("https://npm.pkg.github.com"), "npm.pkg.github.com")
+        self.assertEqual(get_registry_host("https://registry.npmjs.org"), "registry.npmjs.org")
+        self.assertEqual(get_registry_host("https://npm.example.com/custom/path"), "npm.example.com")
+
+    def test_npmrc_contains_scope_registry_matching(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+            f"//{TEST_REGISTRY_HOST}/:_authToken={TEST_AUTH_TOKEN}\n",
+        ]
+        self.assertTrue(npmrc_contains_scope_registry(lines, scope))
+
+    def test_npmrc_contains_scope_registry_not_matching(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        lines = [
+            "@other-scope:registry=https://registry.npmjs.org\n",
+        ]
+        self.assertFalse(npmrc_contains_scope_registry(lines, scope))
+
+    def test_npmrc_contains_scope_registry_empty_lines(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        lines = []
+        self.assertFalse(npmrc_contains_scope_registry(lines, scope))
+
+    def test_npmrc_contains_auth_token_matching(self):
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+            f"//{TEST_REGISTRY_HOST}/:_authToken={TEST_AUTH_TOKEN}\n",
+        ]
+        self.assertTrue(npmrc_contains_auth_token(lines, TEST_REGISTRY))
+
+    def test_npmrc_contains_auth_token_not_matching(self):
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+            "//registry.npmjs.org/:_authToken=some-token\n",
+        ]
+        self.assertFalse(npmrc_contains_auth_token(lines, TEST_REGISTRY))
+
+    def test_npmrc_contains_auth_token_placeholder_rejected(self):
+        lines = [
+            f"//{TEST_REGISTRY_HOST}/:_authToken=UPDATE_WITH_TOKEN\n",
+        ]
+        self.assertFalse(npmrc_contains_auth_token(lines, TEST_REGISTRY))
+
+    def test_npmrc_contains_auth_token_empty_rejected(self):
+        lines = [
+            f"//{TEST_REGISTRY_HOST}/:_authToken=\n",
+        ]
+        self.assertFalse(npmrc_contains_auth_token(lines, TEST_REGISTRY))
+
+    def test_npmrc_scope_is_configured_without_auth(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=False)
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+        ]
+        self.assertTrue(npmrc_scope_is_configured(lines, scope))
+
+    def test_npmrc_scope_is_configured_with_auth_present(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=True)
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+            f"//{TEST_REGISTRY_HOST}/:_authToken={TEST_AUTH_TOKEN}\n",
+        ]
+        self.assertTrue(npmrc_scope_is_configured(lines, scope))
+
+    def test_npmrc_scope_is_configured_with_auth_missing(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=True)
+        lines = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+        ]
+        self.assertFalse(npmrc_scope_is_configured(lines, scope))
+
+    def test_npmrc_scope_is_configured_registry_missing(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        lines = [
+            f"//{TEST_REGISTRY_HOST}/:_authToken={TEST_AUTH_TOKEN}\n",
+        ]
+        self.assertFalse(npmrc_scope_is_configured(lines, scope))
+
+    def test_get_npmrc_suggestion_without_auth(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=False)
+        suggestion = get_npmrc_suggestion(scope)
+        self.assertEqual(suggestion, f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}")
+
+    def test_get_npmrc_suggestion_with_auth(self):
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=True)
+        suggestion = get_npmrc_suggestion(scope)
+        expected = f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n//{TEST_REGISTRY_HOST}/:_authToken=UPDATE_WITH_TOKEN"
+        self.assertEqual(suggestion, expected)
+
+
+class TestNpmrcScopeConfigured(unittest.TestCase):
+    @mock.patch("daktari.checks.npmrc.get_npmrc_contents")
+    def test_returns_pass_when_scope_configured(self, mock_get_contents):
+        mock_get_contents.return_value = [
+            f"@{TEST_SCOPE_NAME}:registry={TEST_REGISTRY}\n",
+            f"//{TEST_REGISTRY_HOST}/:_authToken={TEST_AUTH_TOKEN}\n",
+        ]
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY, require_auth_token=True)
+        result = NpmrcScopeConfigured(scope).check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+
+    @mock.patch("daktari.checks.npmrc.get_npmrc_contents")
+    def test_returns_fail_when_scope_not_configured(self, mock_get_contents):
+        mock_get_contents.return_value = [
+            "@other-scope:registry=https://registry.npmjs.org\n",
+        ]
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        result = NpmrcScopeConfigured(scope).check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+
+    @mock.patch("daktari.checks.npmrc.get_npmrc_contents")
+    def test_returns_fail_when_file_not_found(self, mock_get_contents):
+        mock_get_contents.side_effect = Exception("~/.npmrc does not exist")
+        scope = NpmrcScope(name=TEST_SCOPE_NAME, registry=TEST_REGISTRY)
+        result = NpmrcScopeConfigured(scope).check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+        self.assertIn("does not exist", result.summary)
+
+
+class TestNpmrcGithubTokenValid(unittest.TestCase):
+    @mock.patch("daktari.checks.npmrc.can_run_command")
+    def test_returns_pass_when_token_valid(self, mock_can_run):
+        mock_can_run.return_value = True
+        result = NpmrcGithubTokenValid(scope_name=TEST_SCOPE_NAME, test_package="some-package").check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+        mock_can_run.assert_called_once_with(f"npm view @{TEST_SCOPE_NAME}/some-package version")
+
+    @mock.patch("daktari.checks.npmrc.can_run_command")
+    def test_returns_fail_when_token_invalid(self, mock_can_run):
+        mock_can_run.return_value = False
+        result = NpmrcGithubTokenValid(scope_name=TEST_SCOPE_NAME, test_package="some-package").check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+        mock_can_run.assert_called_once_with(f"npm view @{TEST_SCOPE_NAME}/some-package version")
+
+
+if __name__ == "__main__":
+    unittest.main()

daktari-0.0.306/daktari/checks/test_pnpm.py

@@ -0,0 +1,25 @@
+import unittest
+from unittest import mock
+
+from daktari.check import CheckStatus
+from daktari.checks.pnpm import PnpmInstalled
+
+
+class TestPnpm(unittest.TestCase):
+    @mock.patch("daktari.check.can_run_command")
+    def test_pnpm_installed_returns_pass_when_installed(self, mock_can_run_command):
+        mock_can_run_command.return_value = True
+        result = PnpmInstalled().check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+        mock_can_run_command.assert_called_once_with("pnpm --version")
+
+    @mock.patch("daktari.check.can_run_command")
+    def test_pnpm_installed_returns_fail_when_not_installed(self, mock_can_run_command):
+        mock_can_run_command.return_value = False
+        result = PnpmInstalled().check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+        mock_can_run_command.assert_called_once_with("pnpm --version")
+
+
+if __name__ == "__main__":
+    unittest.main()

{daktari-0.0.300 → daktari-0.0.306/daktari.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daktari
-Version: 0.0.300
+Version: 0.0.306
 Summary: Assist in setting up and maintaining developer environments
 Author-email: Matt Russell <matthew.russell@sonocent.com>
 License: Copyright 2021 Sonocent Ltd
@@ -18,8 +18,8 @@ Requires-Dist: ansicolors==1.1.8
 Requires-Dist: distro==1.9.0
 Requires-Dist: pyfiglet==1.0.4
 Requires-Dist: importlib_resources==6.5.2
-Requires-Dist: packaging==25.0
-Requires-Dist: setuptools==80.9.0
+Requires-Dist: packaging==26.0
+Requires-Dist: setuptools==80.10.2
 Requires-Dist: requests==2.32.5
 Requires-Dist: responses==0.25.8
 Requires-Dist: semver==3.0.4
@@ -33,7 +33,7 @@ Requires-Dist: dpath==2.2.0
 Requires-Dist: pyOpenSSL==25.3.0
 Requires-Dist: types-pyOpenSSL==24.1.0.20240722
 Requires-Dist: pyclip==0.7.0
-Requires-Dist: urllib3==2.6.2
+Requires-Dist: urllib3==2.6.3
 Dynamic: license-file
 
 **Daktari** is a tool to help the initial setup and ongoing maintenance of developer environments. It runs a series of checks (for example, that required software is installed) and provides suggestions on how to fix the issue if the check fails.
@@ -45,7 +45,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.300"
+version = "0.0.306"
 title = "My Project"
 
 checks = [

{daktari-0.0.300 → daktari-0.0.306}/daktari.egg-info/SOURCES.txt

@@ -52,7 +52,9 @@ daktari/checks/java.py
 daktari/checks/kubernetes.py
 daktari/checks/misc.py
 daktari/checks/nodejs.py
+daktari/checks/npmrc.py
 daktari/checks/onepassword.py
+daktari/checks/pnpm.py
 daktari/checks/python.py
 daktari/checks/ssh.py
 daktari/checks/terraform.py
@@ -60,7 +62,9 @@ daktari/checks/test_certs.py
 daktari/checks/test_intellij_idea.py
 daktari/checks/test_java.py
 daktari/checks/test_misc.py
+daktari/checks/test_npmrc.py
 daktari/checks/test_onepassword.py
+daktari/checks/test_pnpm.py
 daktari/checks/test_ssh.py
 daktari/checks/test_yarn.py
 daktari/checks/xml.py

{daktari-0.0.300 → daktari-0.0.306}/daktari.egg-info/requires.txt

@@ -2,8 +2,8 @@ ansicolors==1.1.8
 distro==1.9.0
 pyfiglet==1.0.4
 importlib_resources==6.5.2
-packaging==25.0
-setuptools==80.9.0
+packaging==26.0
+setuptools==80.10.2
 requests==2.32.5
 responses==0.25.8
 semver==3.0.4
@@ -15,7 +15,7 @@ dpath==2.2.0
 pyOpenSSL==25.3.0
 types-pyOpenSSL==24.1.0.20240722
 pyclip==0.7.0
-urllib3==2.6.2
+urllib3==2.6.3
 
 [:sys_platform == "darwin"]
 pyobjc-core==12.0

{daktari-0.0.300 → daktari-0.0.306}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "daktari"
-version = "0.0.300"
+version = "0.0.306"
 description = "Assist in setting up and maintaining developer environments"
 readme = "README.md"
 license = { file = "LICENSE.txt" }

{daktari-0.0.300 → daktari-0.0.306}/requirements.txt

@@ -2,8 +2,8 @@ ansicolors==1.1.8
 distro==1.9.0
 pyfiglet==1.0.4
 importlib_resources==6.5.2
-packaging==25.0
-setuptools==80.9.0
+packaging==26.0
+setuptools==80.10.2
 requests==2.32.5
 responses==0.25.8
 semver==3.0.4
@@ -17,4 +17,4 @@ dpath==2.2.0
 pyOpenSSL==25.3.0
 types-pyOpenSSL==24.1.0.20240722
 pyclip==0.7.0
-urllib3==2.6.2
+urllib3==2.6.3

daktari-0.0.300/daktari/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.300"