Merge pull request #1 from netdevops/initial

initial hier-config-cli

Author: jtdub

.github/workflows/deploy.yaml

@@ -0,0 +1,25 @@
+name: deploy to pypi
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+    - name: Install poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.5.1
+    - name: Build and publish to PyPI
+      env:
+        TWINE_API_KEY: ${{ secrets.TWINE_API_KEY }}
+      run: |
+        poetry config pypi-token.pypi $TWINE_API_KEY
+        poetry publish --build

.github/workflows/test-app.yaml

@@ -0,0 +1,36 @@
+name: hier-config-cli test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.5.1
+    - name: Set PYTHONPATH
+      run: echo "PYTHONPATH=src" >> $GITHUB_ENV
+    - name: Run tests
+      run: |
+        poetry install --no-interaction --no-root
+        poetry run black --check .
+        poetry run pytest tests/

README.md

@@ -1,2 +1,19 @@
 # hier-config-cli
-Hierarchical Configuration CLI
+
+hier-config-cli is a command-line interface tool built on top of the [Hier Config](https://github.com/netdevops/hier_config) library. It enables network engineers to analyze, remediate, and predict configurations for network devices across multiple platforms.
+
+## Usage
+
+```python
+hier-config-cli [COMMAND] --platform PLATFORM --running-config PATH --generated-config PATH
+```
+
+### Available Commands
+
+* remediation
+* rollback
+* future
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for features, bug fixes, or documentation improvements.

poetry.lock

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "hier-config-cli"
+version = "0.1.0"
+description = ""
+authors = ["James Williams <james.williams@packetgeek.net>"]
+license = "Apache 2.0"
+readme = "README.md"
+packages = [{include = "hier_config_cli.py", from = "src"}]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+hier-config = "^3.1.0"
+click = "^8.1.7"
+pyyaml = "^6.0.2"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.10.0"
+pytest = "^8.3.4"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+hier-config-cli = "hier_config_cli:cli"

pyproject.toml

@@ -0,0 +1,119 @@
+import click
+from hier_config import Platform, WorkflowRemediation, get_hconfig
+from hier_config.utils import read_text_from_file
+
+# Mapping for driver platforms
+PLATFORM_MAP = {
+    "ios": Platform.CISCO_IOS,
+    "nxos": Platform.CISCO_NXOS,
+    "iosxr": Platform.CISCO_XR,
+    "eos": Platform.ARISTA_EOS,
+    "junos": Platform.JUNIPER_JUNOS,
+    "vyos": Platform.VYOS,
+    "generic": Platform.GENERIC,
+    "hp_comware5": Platform.HP_COMWARE5,
+    "hp_procurve": Platform.HP_PROCURVE,
+}
+
+
+@click.group()
+def cli():
+    """Hier Config CLI Tool"""
+    pass
+
+
+def common_options(func):
+    """Reusable options for platform, running config, and generated config."""
+    func = click.option(
+        "--platform",
+        type=click.Choice(PLATFORM_MAP.keys(), case_sensitive=False),
+        required=True,
+        help="Platform driver to use (e.g., ios, nxos, iosxr, eos, junos, vyos, generic).",
+    )(func)
+    func = click.option(
+        "--running-config",
+        type=click.Path(exists=True, readable=True),
+        required=True,
+        help="Path to the running configuration file.",
+    )(func)
+    func = click.option(
+        "--generated-config",
+        type=click.Path(exists=True, readable=True),
+        required=True,
+        help="Path to the generated (intended) configuration file.",
+    )(func)
+    return func
+
+
+@cli.command()
+@common_options
+def remediation(platform, running_config, generated_config):
+    """
+    Generate the remediation configuration.
+    """
+    platform_enum = PLATFORM_MAP[platform.lower()]
+    running_config_text = read_text_from_file(running_config)
+    generated_config_text = read_text_from_file(generated_config)
+
+    running_hconfig = get_hconfig(platform_enum, running_config_text)
+    generated_hconfig = get_hconfig(platform_enum, generated_config_text)
+
+    workflow = WorkflowRemediation(running_hconfig, generated_hconfig)
+
+    click.echo("\n=== Remediation Configuration ===")
+    for line in workflow.remediation_config.all_children_sorted():
+        click.echo(line.cisco_style_text())
+
+
+@cli.command()
+@common_options
+def rollback(platform, running_config, generated_config):
+    """
+    Generate the rollback configuration.
+    """
+    platform_enum = PLATFORM_MAP[platform.lower()]
+    running_config_text = read_text_from_file(running_config)
+    generated_config_text = read_text_from_file(generated_config)
+
+    running_hconfig = get_hconfig(platform_enum, running_config_text)
+    generated_hconfig = get_hconfig(platform_enum, generated_config_text)
+
+    workflow = WorkflowRemediation(running_hconfig, generated_hconfig)
+
+    click.echo("\n=== Rollback Configuration ===")
+    for line in workflow.rollback_config.all_children_sorted():
+        click.echo(line.cisco_style_text())
+
+
+@cli.command()
+@common_options
+def future(platform, running_config, generated_config):
+    """
+    Generate the future configuration.
+    """
+    platform_enum = PLATFORM_MAP[platform.lower()]
+    running_config_text = read_text_from_file(running_config)
+    generated_config_text = read_text_from_file(generated_config)
+
+    running_hconfig = get_hconfig(platform_enum, running_config_text)
+    generated_hconfig = get_hconfig(platform_enum, generated_config_text)
+
+    future_config = running_hconfig.future(generated_hconfig)
+
+    click.echo("\n=== Future Configuration ===")
+    for line in future_config.all_children_sorted():
+        click.echo(line.cisco_style_text())
+
+
+@cli.command()
+def list_platforms():
+    """
+    List all available platforms.
+    """
+    click.echo("\n=== Available Platforms ===")
+    for platform in PLATFORM_MAP.keys():
+        click.echo(f"- {platform}")
+
+
+if __name__ == "__main__":
+    cli()

src/hier_config_cli.py

@@ -0,0 +1,92 @@
+import pytest
+from click.testing import CliRunner
+from hier_config_cli import cli
+
+
+# Define test fixtures for mock configurations
+@pytest.fixture
+def mock_running_config(tmp_path):
+    config_path = tmp_path / "running_config.conf"
+    config_path.write_text("hostname test-router\ninterface Vlan1\n")
+    return str(config_path)
+
+
+@pytest.fixture
+def mock_generated_config(tmp_path):
+    config_path = tmp_path / "generated_config.conf"
+    config_path.write_text(
+        "hostname test-router-updated\ninterface Vlan1\n ip address 10.0.0.1 255.255.255.0\n"
+    )
+    return str(config_path)
+
+
+# Test `list_platforms` command
+def test_list_platforms():
+    runner = CliRunner()
+    result = runner.invoke(cli, ["list-platforms"])
+    assert result.exit_code == 0
+    assert "Available Platforms" in result.output
+    assert "ios" in result.output
+    assert "junos" in result.output
+
+
+# Test `remediation` command
+def test_remediation_command(mock_running_config, mock_generated_config):
+    runner = CliRunner()
+    result = runner.invoke(
+        cli,
+        [
+            "remediation",
+            "--platform",
+            "ios",
+            "--running-config",
+            mock_running_config,
+            "--generated-config",
+            mock_generated_config,
+        ],
+    )
+    assert result.exit_code == 0
+    assert "Remediation Configuration" in result.output
+    assert "no hostname test-router" in result.output
+    assert "hostname test-router-updated" in result.output
+
+
+# Test `rollback` command
+def test_rollback_command(mock_running_config, mock_generated_config):
+    runner = CliRunner()
+    result = runner.invoke(
+        cli,
+        [
+            "rollback",
+            "--platform",
+            "ios",
+            "--running-config",
+            mock_running_config,
+            "--generated-config",
+            mock_generated_config,
+        ],
+    )
+    assert result.exit_code == 0
+    assert "Rollback Configuration" in result.output
+    assert "hostname test-router" in result.output
+    assert "no hostname test-router-updated" in result.output
+
+
+# Test `future` command
+def test_future_command(mock_running_config, mock_generated_config):
+    runner = CliRunner()
+    result = runner.invoke(
+        cli,
+        [
+            "future",
+            "--platform",
+            "ios",
+            "--running-config",
+            mock_running_config,
+            "--generated-config",
+            mock_generated_config,
+        ],
+    )
+    assert result.exit_code == 0
+    assert "Future Configuration" in result.output
+    assert "hostname test-router-updated" in result.output