Initial CI build with MISE-EN-PLACE

Author: Brisinger

.gitignore

@@ -0,0 +1,74 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+download/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environment
+.venv/
+venv/
+ENV/
+env/
+
+# Pytest
+.pytest_cache/
+
+# Coverage
+coverage.xml
+htmlcov/
+tests/coverage/
+.coverage
+
+# Mypy
+.mypy_cache/
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# Editor directories and files
+.vscode/
+.idea/
+*.sublime-project
+*.sublime-workspace
+
+# macOS
+.DS_Store
+
+# logs
+*.log
+
+# GitHub Actions
+.github/workflows/
+
+# local config
+.env
+
+# misc
+*.bak
+*.swp
+
+# MISE-EN-PLACE
+.mise_config
+.mise_trusted

mise.toml

@@ -0,0 +1,52 @@
+min_version = "2025.10.0"
+
+[env]
+# Use the project name derived from the current directory
+PROJECT_NAME = "{{ config_root | basename }}"
+
+# Make Python imports resolve to local project root directory's Virtual Environment
+PYTHONPATH = "{{ config_root }}"
+
+# Automatic virtualenv activation
+_.python.venv = { path = ".venv", create = true, python = "3.13.7" }
+
+[tools]
+python = "{{ get_env(name='PYTHON_VERSION', default='3.13.7') }}"
+
+[tasks.install]
+description = "Install dependencies"
+run = "pip install -r requirements.txt"
+
+[tasks.run]
+description = "Run the application"
+run = "python utilities/util.py"
+depends = ["test"]
+
+[tasks.test]
+description = "Run tests"
+run = "pytest tests/"
+depends = ["lint", "install"]
+
+[tasks.coverage]
+description = "Run tests with coverage and generate reports"
+# Use PYTHONPATH per env setting; outputs go to tests/coverage
+run = "pytest --cov=utilities --cov-report=xml:tests/coverage/coverage.xml --cov-report=html:tests/coverage/html tests/"
+depends = ["install", "lint"]
+
+[tasks.lint]
+description = "Lint the code"
+run = "pylint utilities/"
+depends = ["install"]
+
+[tasks.info]
+description = "Print project information"
+run = '''
+echo "Project: $PROJECT_NAME"
+echo "Virtual Environment: $VIRTUAL_ENV"
+'''
+depends = ["run"]
+
+[tasks.build]
+description = "Build the code"
+run = "echo 'Build workflow complete'"
+depends = ["install", "lint", "coverage", "test", "run", "info"]

requirements.txt

@@ -0,0 +1,9 @@
+argcomplete==3.6.2
+click==8.2.1
+packaging==25.0
+pipx==1.7.1
+platformdirs==4.3.8
+userpath==1.9.2
+pytest>=7.0,<8.0
+pylint>=2.17,<3.0
+pytest-cov>=4.1.0

scripts/trust-mise.sh

@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+# scripts/trust-mise.sh
+# Run `mise trust` once for the current directory's `mise.toml` and record the action
+
+set -euo pipefail
+
+# Make the script itself executable so future runs can be invoked directly
+SCRIPT_PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")"
+if [ ! -x "$SCRIPT_PATH" ]; then
+  chmod +x "$SCRIPT_PATH" || true
+fi
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+MARKER_FILE="$ROOT_DIR/.mise_trusted"
+
+echo "Project root: $ROOT_DIR"
+
+if [ -f "$MARKER_FILE" ]; then
+  echo "mise.toml already trusted (marker present at $MARKER_FILE). Skipping."
+  exit 0
+fi
+
+if ! command -v mise >/dev/null 2>&1; then
+  echo "mise is not installed or not on PATH. Install or add mise to PATH and re-run this script." >&2
+  exit 2
+fi
+
+echo "Running: mise trust"
+if mise trust; then
+  # Prepare marker contents: ISO8601 UTC timestamp and IP
+  TIMESTAMP_UTC=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+
+  # Try to obtain public IP (short timeout). Fall back to local interface addresses.
+  PUBLIC_IP=""
+  if command -v curl >/dev/null 2>&1; then
+    PUBLIC_IP=$(curl -s --max-time 3 https://api.ipify.org || true)
+    if [ -z "$PUBLIC_IP" ]; then
+      PUBLIC_IP=$(curl -s --max-time 3 https://ifconfig.co || true)
+    fi
+  fi
+
+  LOCAL_IP=""
+  # macOS: try ipconfig, Linux: try hostname -I or ip
+  if [ -z "$PUBLIC_IP" ]; then
+    if command -v ip >/dev/null 2>&1; then
+      LOCAL_IP=$(ip route get 1.1.1.1 2>/dev/null | awk '{for(i=1;i<=NF;i++) if($i=="src") print $(i+1)}' | head -n1 || true)
+    fi
+    if [ -z "$LOCAL_IP" ] && command -v hostname >/dev/null 2>&1; then
+      # hostname -I is not available on macOS; try ipconfig on mac
+      if command -v ipconfig >/dev/null 2>&1; then
+        LOCAL_IP=$(ipconfig getifaddr en0 2>/dev/null || true)
+      fi
+      if [ -z "$LOCAL_IP" ]; then
+        LOCAL_IP=$(hostname -I 2>/dev/null | awk '{print $1}' || true)
+      fi
+    fi
+  fi
+
+  # Choose which IP to log
+  if [ -n "$PUBLIC_IP" ]; then
+    CHOSEN_IP="$PUBLIC_IP"
+  elif [ -n "$LOCAL_IP" ]; then
+    CHOSEN_IP="$LOCAL_IP"
+  else
+    CHOSEN_IP="unknown"
+  fi
+
+  cat > "$MARKER_FILE" <<EOF
+trusted: true
+timestamp_utc: $TIMESTAMP_UTC
+ip: $CHOSEN_IP
+EOF
+
+  echo "mise.toml trusted and marker created at $MARKER_FILE"
+else
+  echo "mise trust failed." >&2
+  exit 3
+fi
+
+exit 0

tests/test_util.py

@@ -0,0 +1,100 @@
+"""Unit tests for utilities.util module."""
+
+import pytest
+from utilities.util import (
+    TemperatureFormatNotSupported,
+    _to_float_temperature,
+    convert_farenheit_to_celsius,
+    convert_celsius_to_farenheit,
+)
+
+
+@pytest.mark.parametrize(
+    "temperature, expected",
+    [
+        (100, 100.0),
+        (36.6, 36.6),
+        ("  12.5 ", 12.5),
+    ],
+)
+def test_to_float_valid_inputs(temperature, expected):
+    """Test _to_float_temperature with valid inputs (parameterized).
+    
+    Args:
+        temperature: Input temperature value (int, float, or numeric string).
+        expected: Expected float output temperature.
+    """
+    assert _to_float_temperature(temperature) == expected
+
+
+def test_to_float_invalid_empty_string():
+    """Test _to_float_temperature with an empty string."""
+
+    with pytest.raises(TemperatureFormatNotSupported) as exc:
+        _to_float_temperature("")
+    assert "Empty string" in str(exc.value)
+
+
+def test_to_float_invalid_string():
+    """Test _to_float_temperature with a non-numeric string."""
+
+    with pytest.raises(TemperatureFormatNotSupported) as exc:
+        _to_float_temperature("abc")
+    assert "is not a valid temperature" in str(exc.value)
+
+
+@pytest.mark.parametrize(
+    "temperature, expected",
+    [
+        (32, 0.0),
+        (212, 100.0),
+        ("212", 100.0),
+    ],
+)
+def test_convert_fahrenheit_to_celsius(temperature, expected):
+    """Test convert_farenheit_to_celsius with valid inputs.
+    
+    Args:
+        temperature: Input temperature in Fahrenheit (int, float, or numeric string).
+        expected: Expected float output temperature in Celsius.
+    """
+
+    assert convert_farenheit_to_celsius(temperature) == pytest.approx(expected)
+
+
+@pytest.mark.parametrize(
+    "temperature, expected",
+    [
+        (0, 32.0),
+        (100, 212.0),
+        ("100", 212.0),
+    ],
+)
+def test_convert_celsius_to_fahrenheit(temperature, expected):
+    """Test convert_celsius_to_farenheit with valid inputs.
+    
+    Args:
+        temperature: Input temperature in Celsius (int, float, or numeric string).
+        expected: Expected float output temperature in Fahrenheit.
+    """
+
+    assert convert_celsius_to_farenheit(temperature) == pytest.approx(expected)
+
+
+@pytest.mark.parametrize(
+    "temperature",
+    [[], {}, None, object()],
+)
+def test_convert_invalid_inputs_raise(temperature):
+    """Test conversion functions with invalid inputs.
+    
+    Args:
+        temperature: Invalid input temperature types (list, dict, None, object).
+    
+    Raises:
+        TemperatureFormatNotSupported: For each invalid input type.
+    """
+
+    for fn in (convert_farenheit_to_celsius, convert_celsius_to_farenheit):
+        with pytest.raises(TemperatureFormatNotSupported):
+            fn(temperature)

utilities/__init__.py

@@ -0,0 +1,6 @@
+"""Utilities package for project.
+
+This package exposes utility modules used by tests and application.
+"""
+
+__all__ = ["util"]