daktari 0.0.298__py3-none-any.whl → 0.0.303__py3-none-any.whl

daktari/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.298"
+__version__ = "0.0.303"

daktari/checks/npmrc.py

@@ -0,0 +1,136 @@
+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
+
+
+@dataclass
+class NpmrcScope:
+    name: str
+    registry: str
+    requireAuthToken: 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:
+        stripped = line.strip()
+        if stripped == expected_line or stripped.startswith(expected_line + "\n"):
+            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 != "UPDATE_WITH_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.requireAuthToken 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.requireAuthToken:
+        host = get_registry_host(scope.registry)
+        lines.append(f"//{host}/:_authToken=UPDATE_WITH_TOKEN")
+    return "\n".join(lines)
+
+
+def get_npmrc_token_for_registry(registry_url: str) -> Optional[str]:
+    lines = get_npmrc_contents()
+    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):
+            return stripped[len(auth_token_prefix) :]
+    return None
+
+
+class NpmrcScopeConfigured(Check):
+    name = "npmrc.scopeConfigured"
+
+    def __init__(self, scope: NpmrcScope, tokenInstructions: Optional[str] = None):
+        self.scope = scope
+        self.npmrc_suggestion = get_npmrc_suggestion(scope)
+        tokenInstructionString = f"\n\n{tokenInstructions}" if tokenInstructions else ""
+        self.suggestions = {
+            OS.GENERIC: f"""Add the lines below to ~/.npmrc:
+
+{self.npmrc_suggestion}{tokenInstructionString}"""
+        }
+
+    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/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/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, requireAuthToken=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, requireAuthToken=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, requireAuthToken=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, requireAuthToken=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, requireAuthToken=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, requireAuthToken=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/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.298.dist-info → daktari-0.0.303.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daktari
-Version: 0.0.298
+Version: 0.0.303
 Summary: Assist in setting up and maintaining developer environments
 Author-email: Matt Russell <matthew.russell@sonocent.com>
 License: Copyright 2021 Sonocent Ltd
@@ -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.5.0
+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.298"
+version = "0.0.303"
 title = "My Project"
 
 checks = [

{daktari-0.0.298.dist-info → daktari-0.0.303.dist-info}/RECORD

@@ -1,4 +1,4 @@
-daktari/__init__.py,sha256=CH3o5OGlxJBL5e0uaz27Kc-Gfy_rptkWI3Dz896f1gY,24
+daktari/__init__.py,sha256=BDs1YTavXW5cEXxV1GC0G1gQi5n9pQ6qqvxpiQRcIqE,24
 daktari/__main__.py,sha256=iYwgtZZE2HD9Eh9Io6OliGQwCNZJSde_66jI6kF8xJU,1463
 daktari/asdf.py,sha256=fALVL6UTz1AYxuabw9MZeAES7J_CvImutUDD1Y2yWwM,509
 daktari/check.py,sha256=WzIiCrrdH7gCbElNwYbYkjhpmaOs_nUWfvkTBkfZlgs,4133
@@ -41,7 +41,9 @@ daktari/checks/java.py,sha256=vS4gfuLwLxuTLizvybRx2yYXnNLMTsSfmoYHp91rono,3542
 daktari/checks/kubernetes.py,sha256=BJjxAZzZ3y3t7oHBruUy8OxP41JaX0cxlLvTnFz-F8s,5886
 daktari/checks/misc.py,sha256=O9_cCkcbigMF7uoqUebDT7mMmmKzQ8EwmIQRBY6vZcc,10855
 daktari/checks/nodejs.py,sha256=KOCLNQqZqaCalxcIajoDQDom1Zi4_noV4mV_-YZv_4E,2873
+daktari/checks/npmrc.py,sha256=z-hyy4Zevv8q9AE8f5ua54PoSASMk7HLF39Hf2nDWvU,4546
 daktari/checks/onepassword.py,sha256=C2HWNlypBDTUx4K4IrrEVIkMqivKzX97oE0rENP1xK4,4155
+daktari/checks/pnpm.py,sha256=alEmcc1F-T998ECZ7p7JJ4DaaznnzLwLFz--7mV33Dk,339
 daktari/checks/python.py,sha256=v6xuRwtFCjzTYMN3qRLu76Xm7Bn8NO7wVpI3d8dOBSc,658
 daktari/checks/ssh.py,sha256=NqFhO03u523yQaffCeemcRtnYowx6LDuufayzF1t5eQ,1285
 daktari/checks/terraform.py,sha256=fvA7VRRJftkISqcnEjbc9dUovfXEe0eXrQl2MvsnfSM,2476
@@ -49,7 +51,9 @@ daktari/checks/test_certs.py,sha256=LmwjzNBEJauGSFYYLGevJ5H3FRkaO0piezUm3P-hrbM,
 daktari/checks/test_intellij_idea.py,sha256=dJ7Nu0eVyv1cpo8h5wUJ6w1rmsbGg3yxslaQKHT3So4,3207
 daktari/checks/test_java.py,sha256=f-JFGI-J-pBD1WgY8a88BO7XeJhvD87QSZK0kDnflls,3613
 daktari/checks/test_misc.py,sha256=tTvaPaZORjNf1dV8wPUKXDI3-JksyfdOsnZXFs7SLLE,587
+daktari/checks/test_npmrc.py,sha256=mJG_kO5a7bqWx0NaBRrV6X_4_GKB5-6vU_6uKZQHAmU,7168
 daktari/checks/test_onepassword.py,sha256=HLeNjkZd85ty1U4Ut3OSjWVa5msC1Fp1OF0IIWD69u4,1115
+daktari/checks/test_pnpm.py,sha256=mZJgQ149V91YtxU4nENtalyyHZBawg4lbtxcW3IoWI0,925
 daktari/checks/test_ssh.py,sha256=XJECzM9BNODSxfkK71P9TyavlBagzgkCfKWdhlOD7zU,930
 daktari/checks/test_yarn.py,sha256=9z6NenjJGlWjl5fFQSPVrfiInbvVTxnVhQ-jZkupi6o,4337
 daktari/checks/xml.py,sha256=BqOAI2QRLYE7QL7lFnk_fdxbLnt6ow5c7rmnLiDbNPo,1019
@@ -57,9 +61,9 @@ daktari/checks/yarn.py,sha256=T8b_oOoZ4l96delmPgPfgtaTkiUS129hoWlGIBcU7Io,5534
 daktari/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 daktari/resources/daktari-local-template.yaml,sha256=ik7KzMcG1r90nxDOk7t5G7P-BSxQIl2PocGUVe14c44,503
 daktari/resources/mock_cert.pem,sha256=AIc9dZOVIuxm7KFLunP5WSA1-LDWLOwpfu48B9xQ_Wg,82
-daktari-0.0.298.dist-info/licenses/LICENSE.txt,sha256=sMo18UdnQ7rY1SYg9gmop08ubzEQOGO1URYXu1Hxdx0,1051
-daktari-0.0.298.dist-info/METADATA,sha256=bBYc40_zfWSvurlyxRYO2rZzMLiLvQHNTReVvbtpXok,4557
-daktari-0.0.298.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-daktari-0.0.298.dist-info/entry_points.txt,sha256=mfQXkwKyloAzf7sv78icBo1PtRwf9hCP_816F6REf-I,50
-daktari-0.0.298.dist-info/top_level.txt,sha256=LW6kawKAAyxUbGqpAbdedKRUyVy2DBzEZOalp0qDdF8,8
-daktari-0.0.298.dist-info/RECORD,,
+daktari-0.0.303.dist-info/licenses/LICENSE.txt,sha256=sMo18UdnQ7rY1SYg9gmop08ubzEQOGO1URYXu1Hxdx0,1051
+daktari-0.0.303.dist-info/METADATA,sha256=CRag-PvQZ0oOqNhrYvrf8RSMV4XzhV4uoq6joGqjkR0,4557
+daktari-0.0.303.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+daktari-0.0.303.dist-info/entry_points.txt,sha256=mfQXkwKyloAzf7sv78icBo1PtRwf9hCP_816F6REf-I,50
+daktari-0.0.303.dist-info/top_level.txt,sha256=LW6kawKAAyxUbGqpAbdedKRUyVy2DBzEZOalp0qDdF8,8
+daktari-0.0.303.dist-info/RECORD,,

{daktari-0.0.298.dist-info → daktari-0.0.303.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any