mcp-souschef 2.2.0__py3-none-any.whl → 2.8.0__py3-none-any.whl

souschef/cli.py

@@ -11,6 +11,7 @@ from typing import NoReturn
 
 import click
 
+from souschef.converters.playbook import generate_playbook_from_recipe
 from souschef.profiling import (
     generate_cookbook_performance_report,
     profile_function,
@@ -18,7 +19,10 @@ from souschef.profiling import (
 from souschef.server import (
     convert_inspec_to_test,
     convert_resource_to_task,
+    generate_github_workflow_from_chef,
+    generate_gitlab_ci_from_chef,
     generate_inspec_from_recipe,
+    generate_jenkinsfile_from_chef,
     list_cookbook_structure,
     list_directory,
     parse_attributes,
@@ -30,6 +34,11 @@ from souschef.server import (
     read_file,
 )
 
+# CI/CD job description constants
+CI_JOB_LINT = "  • Lint (cookstyle/foodcritic)"
+CI_JOB_UNIT_TESTS = "  • Unit Tests (ChefSpec)"
+CI_JOB_INTEGRATION_TESTS = "  • Integration Tests (Test Kitchen)"
+
 
 @click.group()
 @click.version_option(version="0.1.0", prog_name="souschef")
@@ -272,16 +281,16 @@ def _display_template_summary(template_file: Path) -> None:
 @click.option("--dry-run", is_flag=True, help="Show what would be done")
 def cookbook(cookbook_path: str, output: str | None, dry_run: bool) -> None:
     """
-    Analyze an entire Chef cookbook.
+    Analyse an entire Chef cookbook.
 
     COOKBOOK_PATH: Path to the cookbook root directory
 
-    This command analyzes the cookbook structure, metadata, recipes,
+    This command analyses the cookbook structure, metadata, recipes,
     attributes, templates, and custom resources.
     """
     cookbook_dir = Path(cookbook_path)
 
-    click.echo(f"Analyzing cookbook: {cookbook_dir.name}")
+    click.echo(f"Analysing cookbook: {cookbook_dir.name}")
     click.echo("=" * 50)
 
     # Parse metadata
@@ -350,7 +359,7 @@ def inspec_parse(path: str, output_format: str) -> None:
 @click.option(
     "--format",
     "output_format",
-    type=click.Choice(["testinfra", "ansible_assert"]),
+    type=click.Choice(["testinfra", "ansible_assert", "serverspec", "goss"]),
     default="testinfra",
     help="Output format for converted tests",
 )
@@ -382,6 +391,241 @@ def inspec_generate(path: str, output_format: str) -> None:
     _output_result(result, output_format)
 
 
+@cli.command()
+@click.argument("cookbook_path", type=click.Path(exists=True))
+@click.option(
+    "--output",
+    "-o",
+    type=click.Path(),
+    help="Output file path for Jenkinsfile (default: ./Jenkinsfile)",
+)
+@click.option(
+    "--pipeline-type",
+    type=click.Choice(["declarative", "scripted"]),
+    default="declarative",
+    help="Jenkins pipeline type (default: declarative)",
+)
+@click.option(
+    "--parallel/--no-parallel",
+    default=True,
+    help="Enable parallel test execution (default: enabled)",
+)
+def generate_jenkinsfile(
+    cookbook_path: str, output: str | None, pipeline_type: str, parallel: bool
+) -> None:
+    """
+    Generate Jenkinsfile for Chef cookbook CI/CD.
+
+    COOKBOOK_PATH: Path to the Chef cookbook root directory
+
+    This command analyses the cookbook for CI patterns (Test Kitchen,
+    lint tools, test suites) and generates an appropriate Jenkinsfile
+    with stages for linting, testing, and convergence.
+
+    Examples:
+      souschef generate-jenkinsfile ./mycookbook
+
+      souschef generate-jenkinsfile ./mycookbook -o Jenkinsfile.new
+
+      souschef generate-jenkinsfile ./mycookbook --pipeline-type scripted
+
+      souschef generate-jenkinsfile ./mycookbook --no-parallel
+
+    """
+    try:
+        result = generate_jenkinsfile_from_chef(
+            cookbook_path=cookbook_path,
+            pipeline_type=pipeline_type,
+            enable_parallel="yes" if parallel else "no",
+        )
+
+        # Determine output path
+        output_path = Path(output) if output else Path.cwd() / "Jenkinsfile"
+
+        # Write Jenkinsfile
+        output_path.write_text(result)
+        click.echo(f"✓ Generated {pipeline_type} Jenkinsfile: {output_path}")
+
+        # Show summary
+        click.echo("\nGenerated Pipeline Stages:")
+        if "stage('Lint')" in result or "stage 'Lint'" in result:
+            click.echo(CI_JOB_LINT)
+        if "stage('Unit Tests')" in result or "stage 'Unit Tests'" in result:
+            click.echo(CI_JOB_UNIT_TESTS)
+        integration_stage = (
+            "stage('Integration Tests')" in result
+            or "stage 'Integration Tests'" in result
+        )
+        if integration_stage:
+            click.echo(CI_JOB_INTEGRATION_TESTS)
+
+        if parallel:
+            click.echo("\nParallel execution: Enabled")
+        else:
+            click.echo("\nParallel execution: Disabled")
+
+    except Exception as e:
+        click.echo(f"Error generating Jenkinsfile: {e}", err=True)
+        sys.exit(1)
+
+
+@cli.command()
+@click.argument("cookbook_path", type=click.Path(exists=True))
+@click.option(
+    "--output",
+    "-o",
+    type=click.Path(),
+    help="Output file path for .gitlab-ci.yml (default: ./.gitlab-ci.yml)",
+)
+@click.option(
+    "--cache/--no-cache",
+    default=True,
+    help="Enable dependency caching (default: enabled)",
+)
+@click.option(
+    "--artifacts/--no-artifacts",
+    default=True,
+    help="Enable test report artifacts (default: enabled)",
+)
+def generate_gitlab_ci(
+    cookbook_path: str, output: str | None, cache: bool, artifacts: bool
+) -> None:
+    """
+    Generate .gitlab-ci.yml for Chef cookbook CI/CD.
+
+    COOKBOOK_PATH: Path to the Chef cookbook root directory
+
+    This command analyses the cookbook for CI patterns (Test Kitchen,
+    lint tools, test suites) and generates an appropriate GitLab CI
+    configuration with jobs for linting, testing, and convergence.
+
+    Examples:
+      souschef generate-gitlab-ci ./mycookbook
+
+      souschef generate-gitlab-ci ./mycookbook -o .gitlab-ci.test.yml
+
+      souschef generate-gitlab-ci ./mycookbook --no-cache
+
+      souschef generate-gitlab-ci ./mycookbook --no-artifacts
+
+    """
+    try:
+        result = generate_gitlab_ci_from_chef(
+            cookbook_path=cookbook_path,
+            enable_cache="yes" if cache else "no",
+            enable_artifacts="yes" if artifacts else "no",
+        )
+
+        # Determine output path
+        output_path = Path(output) if output else Path.cwd() / ".gitlab-ci.yml"
+
+        # Write GitLab CI config
+        output_path.write_text(result)
+        click.echo(f"✓ Generated GitLab CI configuration: {output_path}")
+
+        # Show summary
+        click.echo("\nGenerated CI Jobs:")
+        if "cookstyle:" in result or "foodcritic:" in result:
+            click.echo(CI_JOB_LINT)
+        if "unit-test:" in result or "chefspec:" in result:
+            click.echo(CI_JOB_UNIT_TESTS)
+        if "integration-test:" in result or "kitchen-" in result:
+            click.echo(CI_JOB_INTEGRATION_TESTS)
+
+        click.echo(f"\nCache: {'Enabled' if cache else 'Disabled'}")
+        click.echo(f"Artifacts: {'Enabled' if artifacts else 'Disabled'}")
+
+    except Exception as e:
+        click.echo(f"Error generating GitLab CI configuration: {e}", err=True)
+        sys.exit(1)
+
+
+@cli.command()
+@click.argument("cookbook_path", type=click.Path(exists=True))
+@click.option(
+    "--output",
+    "-o",
+    type=click.Path(),
+    help="Output file path for workflow (default: ./.github/workflows/ci.yml)",
+)
+@click.option(
+    "--workflow-name",
+    default="Chef Cookbook CI",
+    help="GitHub Actions workflow name (default: Chef Cookbook CI)",
+)
+@click.option(
+    "--cache/--no-cache",
+    default=True,
+    help="Enable dependency caching (default: enabled)",
+)
+@click.option(
+    "--artifacts/--no-artifacts",
+    default=True,
+    help="Enable test report artifacts (default: enabled)",
+)
+def generate_github_workflow(
+    cookbook_path: str,
+    output: str | None,
+    workflow_name: str,
+    cache: bool,
+    artifacts: bool,
+) -> None:
+    """
+    Generate GitHub Actions workflow for Chef cookbook CI/CD.
+
+    COOKBOOK_PATH: Path to the Chef cookbook root directory
+
+    This command analyses the cookbook for CI patterns (Test Kitchen,
+    lint tools, test suites) and generates an appropriate GitHub Actions
+    workflow with jobs for linting, testing, and convergence.
+
+    Examples:
+      souschef generate-github-workflow ./mycookbook
+
+      souschef generate-github-workflow ./mycookbook -o .github/workflows/test.yml
+
+      souschef generate-github-workflow ./mycookbook --no-cache
+
+      souschef generate-github-workflow ./mycookbook --workflow-name "CI Pipeline"
+
+    """
+    try:
+        result = generate_github_workflow_from_chef(
+            cookbook_path=cookbook_path,
+            workflow_name=workflow_name,
+            enable_cache="yes" if cache else "no",
+            enable_artifacts="yes" if artifacts else "no",
+        )
+
+        # Determine output path
+        if output:
+            output_path = Path(output)
+        else:
+            workflows_dir = Path.cwd() / ".github" / "workflows"
+            workflows_dir.mkdir(parents=True, exist_ok=True)
+            output_path = workflows_dir / "ci.yml"
+
+        # Write workflow file
+        output_path.write_text(result)
+        click.echo(f"✓ Generated GitHub Actions workflow: {output_path}")
+
+        # Show summary
+        click.echo("\nGenerated Workflow Jobs:")
+        if "lint:" in result:
+            click.echo(CI_JOB_LINT)
+        if "unit-test:" in result:
+            click.echo(CI_JOB_UNIT_TESTS)
+        if "integration-test:" in result:
+            click.echo(CI_JOB_INTEGRATION_TESTS)
+
+        click.echo(f"\nCache: {'Enabled' if cache else 'Disabled'}")
+        click.echo(f"Artifacts: {'Enabled' if artifacts else 'Disabled'}")
+
+    except Exception as e:
+        click.echo(f"Error generating GitHub Actions workflow: {e}", err=True)
+        sys.exit(1)
+
+
 def _output_json_format(result: str) -> None:
     """Output result as JSON format."""
     try:
@@ -443,7 +687,7 @@ def profile(cookbook_path: str, output: str | None) -> None:
 
     COOKBOOK_PATH: Path to the Chef cookbook to profile
 
-    This command analyzes the performance of parsing all cookbook components
+    This command analyses the performance of parsing all cookbook components
     (recipes, attributes, resources, templates) and provides recommendations
     for optimization.
     """
@@ -515,6 +759,362 @@ def profile_operation(operation: str, path: str, detailed: bool) -> None:
         sys.exit(1)
 
 
+@cli.command("convert-recipe")
+@click.option(
+    "--cookbook-path",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the Chef cookbook directory",
+)
+@click.option(
+    "--recipe-name",
+    default="default",
+    help="Name of the recipe to convert (default: default)",
+)
+@click.option(
+    "--output-path",
+    required=True,
+    type=click.Path(),
+    help="Directory where Ansible playbook will be written",
+)
+def convert_recipe(cookbook_path: str, recipe_name: str, output_path: str) -> None:
+    r"""
+    Convert a Chef recipe to an Ansible playbook.
+
+    This command converts a Chef recipe to an Ansible playbook and writes
+    it to the specified output path. Used by the Terraform provider.
+
+    Example:
+        souschef convert-recipe --cookbook-path /chef/cookbooks/nginx \\
+                                --recipe-name default \\
+                                --output-path /ansible/playbooks
+
+    """
+    try:
+        cookbook_dir = Path(cookbook_path)
+        output_dir = Path(output_path)
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        # Check recipe exists
+        recipe_file = cookbook_dir / "recipes" / f"{recipe_name}.rb"
+        if not recipe_file.exists():
+            click.echo(
+                f"Error: Recipe {recipe_name}.rb not found in {cookbook_path}/recipes",
+                err=True,
+            )
+            sys.exit(1)
+
+        # Get cookbook name
+        metadata_file = cookbook_dir / "metadata.rb"
+        cookbook_name = cookbook_dir.name  # Default to directory name
+
+        if metadata_file.exists():
+            metadata_result = read_cookbook_metadata(str(metadata_file))
+            # Try to parse cookbook name from metadata
+            for line in metadata_result.split("\n"):
+                if line.startswith("name"):
+                    cookbook_name = line.split(":", 1)[1].strip()
+                    break
+
+        # Generate playbook
+        click.echo(f"Converting {cookbook_name}::{recipe_name} to Ansible...")
+        playbook_yaml = generate_playbook_from_recipe(str(recipe_file))
+
+        # Write output
+        output_file = output_dir / f"{recipe_name}.yml"
+        output_file.write_text(playbook_yaml)
+
+        click.echo(f"✓ Playbook written to: {output_file}")
+        click.echo(f"  Size: {len(playbook_yaml)} bytes")
+
+    except Exception as e:
+        click.echo(f"Error converting recipe: {e}", err=True)
+        sys.exit(1)
+
+
+@cli.command("assess-cookbook")
+@click.option(
+    "--cookbook-path",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the Chef cookbook directory",
+)
+@click.option(
+    "--format",
+    "output_format",
+    type=click.Choice(["text", "json"]),
+    default="json",
+    help="Output format (default: json)",
+)
+def assess_cookbook(cookbook_path: str, output_format: str) -> None:
+    """
+    Assess a Chef cookbook for migration complexity.
+
+    Analyses the cookbook and provides complexity level, recipe/resource counts,
+    estimated migration effort, and recommendations. Used by Terraform provider.
+
+    Example:
+        souschef assess-cookbook --cookbook-path /chef/cookbooks/nginx --format json
+
+    """
+    try:
+        cookbook_dir = Path(cookbook_path)
+        if not cookbook_dir.exists():
+            click.echo(
+                f"Error: Cookbook path does not exist: {cookbook_path}",
+                err=True,
+            )
+            sys.exit(1)
+
+        if not cookbook_dir.is_dir():
+            click.echo(f"Error: {cookbook_path} is not a directory", err=True)
+            sys.exit(1)
+
+        # Analyse cookbook
+        analysis = _analyse_cookbook_for_assessment(cookbook_dir)
+
+        if output_format == "json":
+            click.echo(json.dumps(analysis))
+        else:
+            _display_assessment_text(cookbook_dir.name, analysis)
+
+    except Exception as e:
+        click.echo(f"Error assessing cookbook: {e}", err=True)
+        sys.exit(1)
+
+
+def _analyse_cookbook_for_assessment(cookbook_dir: Path) -> dict:
+    """Analyse cookbook and return assessment data."""
+    recipe_count = 0
+    resource_count = 0
+    recipes_dir = cookbook_dir / "recipes"
+
+    if recipes_dir.exists():
+        recipe_files = list(recipes_dir.glob("*.rb"))
+        recipe_count = len(recipe_files)
+        for recipe_file in recipe_files:
+            content = recipe_file.read_text()
+            resource_count += content.count(" do\n") + content.count(" do\r\n")
+
+    # Determine complexity
+    if recipe_count == 0:
+        complexity = "Low"
+        estimated_hours = 0.5
+    elif recipe_count <= 3 and resource_count <= 10:
+        complexity = "Low"
+        estimated_hours = resource_count * 0.5
+    elif recipe_count <= 10 and resource_count <= 50:
+        complexity = "Medium"
+        estimated_hours = resource_count * 1.0
+    else:
+        complexity = "High"
+        estimated_hours = resource_count * 1.5
+
+    recommendations = (
+        f"Cookbook has {recipe_count} recipes with {resource_count} resources. "
+    )
+    if complexity == "Low":
+        recommendations += "Straightforward migration recommended."
+    elif complexity == "Medium":
+        recommendations += "Moderate effort required. Consider phased approach."
+    else:
+        recommendations += (
+            "Complex migration. Recommend incremental migration strategy."
+        )
+
+    return {
+        "complexity": complexity,
+        "recipe_count": recipe_count,
+        "resource_count": resource_count,
+        "estimated_hours": estimated_hours,
+        "recommendations": recommendations,
+    }
+
+
+def _display_assessment_text(cookbook_name: str, analysis: dict) -> None:
+    """Display assessment in human-readable text format."""
+    click.echo(f"\nCookbook: {cookbook_name}")
+    click.echo("=" * 50)
+    click.echo(f"Complexity: {analysis['complexity']}")
+    click.echo(f"Recipe Count: {analysis['recipe_count']}")
+    click.echo(f"Resource Count: {analysis['resource_count']}")
+    click.echo(f"Estimated Hours: {analysis['estimated_hours']}")
+    click.echo(f"\nRecommendations:\n{analysis['recommendations']}")
+
+
+@cli.command("convert-habitat")
+@click.option(
+    "--plan-path",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the Habitat plan.sh file",
+)
+@click.option(
+    "--output-path",
+    required=True,
+    type=click.Path(),
+    help="Directory where Dockerfile will be written",
+)
+@click.option(
+    "--base-image",
+    default="ubuntu:latest",
+    help="Base Docker image to use (default: ubuntu:latest)",
+)
+def convert_habitat(plan_path: str, output_path: str, base_image: str) -> None:
+    r"""
+    Convert a Chef Habitat plan to a Dockerfile.
+
+    Analyses the Habitat plan.sh file and generates an equivalent Dockerfile
+    for containerised deployment. Used by Terraform provider.
+
+    Example:
+        souschef convert-habitat --plan-path /hab/plans/nginx/plan.sh \
+            --output-path /docker/nginx --base-image ubuntu:22.04
+
+    """
+    try:
+        plan_file = Path(plan_path)
+        if not plan_file.exists():
+            click.echo(f"Error: Plan file does not exist: {plan_path}", err=True)
+            sys.exit(1)
+
+        if not plan_file.is_file():
+            click.echo(f"Error: {plan_path} is not a file", err=True)
+            sys.exit(1)
+
+        output_dir = Path(output_path)
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        # Call server function to convert
+        from souschef.server import convert_habitat_to_dockerfile
+
+        dockerfile_content = convert_habitat_to_dockerfile(str(plan_path), base_image)
+
+        # Write Dockerfile
+        dockerfile_path = output_dir / "Dockerfile"
+        dockerfile_path.write_text(dockerfile_content)
+
+        click.echo(f"Successfully converted Habitat plan to {dockerfile_path}")
+        click.echo(f"Dockerfile size: {len(dockerfile_content)} bytes")
+
+    except Exception as e:
+        click.echo(f"Error converting Habitat plan: {e}", err=True)
+        sys.exit(1)
+
+
+@cli.command("convert-inspec")
+@click.option(
+    "--profile-path",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the InSpec profile directory",
+)
+@click.option(
+    "--output-path",
+    required=True,
+    type=click.Path(),
+    help="Directory where converted tests will be written",
+)
+@click.option(
+    "--format",
+    "output_format",
+    type=click.Choice(["testinfra", "serverspec", "goss", "ansible"]),
+    default="testinfra",
+    help="Output test framework format (default: testinfra)",
+)
+def convert_inspec(profile_path: str, output_path: str, output_format: str) -> None:
+    r"""
+    Convert a Chef InSpec profile to various test frameworks.
+
+    Analyses the InSpec profile and generates equivalent tests in the
+    specified framework. Supports TestInfra, Serverspec, Goss, and Ansible.
+
+    Example:
+        souschef convert-inspec --profile-path /inspec/profiles/linux \
+            --output-path /tests/testinfra --format testinfra
+
+    """
+    try:
+        profile_dir = Path(profile_path)
+        if not profile_dir.exists():
+            click.echo(
+                f"Error: Profile path does not exist: {profile_path}",
+                err=True,
+            )
+            sys.exit(1)
+
+        if not profile_dir.is_dir():
+            click.echo(f"Error: {profile_path} is not a directory", err=True)
+            sys.exit(1)
+
+        output_dir = Path(output_path)
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        # Call server function to convert
+        from souschef.server import convert_inspec_to_test
+
+        test_content = convert_inspec_to_test(str(profile_path), output_format)
+
+        # Determine output filename based on format
+        filename_map = {
+            "testinfra": "test_spec.py",
+            "serverspec": "spec_helper.rb",
+            "goss": "goss.yaml",
+            "ansible": "assert.yml",
+        }
+        output_filename = filename_map.get(output_format, "test.txt")
+
+        # Write test file
+        test_file_path = output_dir / output_filename
+        test_file_path.write_text(test_content)
+
+        click.echo(f"Successfully converted InSpec profile to {output_format} format")
+        click.echo(f"Test file: {test_file_path}")
+        click.echo(f"File size: {len(test_content)} bytes")
+
+    except Exception as e:
+        click.echo(f"Error converting InSpec profile: {e}", err=True)
+        sys.exit(1)
+
+
+@cli.command()
+@click.option("--port", default=8501, help="Port to run the Streamlit app on")
+def ui(port: int) -> None:
+    """
+    Launch the SousChef Visual Migration Planning Interface.
+
+    Opens a web-based interface for interactive Chef to Ansible migration planning,
+    cookbook analysis, and visualization.
+    """
+    try:
+        import subprocess
+        import sys
+
+        # Launch Streamlit app
+        cmd = [
+            sys.executable,
+            "-m",
+            "streamlit",
+            "run",
+            "souschef/ui/app.py",
+            "--server.port",
+            str(port),
+        ]
+        click.echo(f"Starting SousChef UI on http://localhost:{port}")
+        click.echo("Press Ctrl+C to stop the server")
+
+        subprocess.run(cmd, check=True)
+
+    except subprocess.CalledProcessError as e:
+        click.echo(f"Error starting UI: {e}", err=True)
+        sys.exit(1)
+    except ImportError:
+        click.echo(
+            "Streamlit is not installed. Install with: pip install streamlit", err=True
+        )
+        sys.exit(1)
+
+
 def main() -> NoReturn:
     """Run the CLI."""
     cli()

souschef/converters/__init__.py

@@ -5,7 +5,7 @@ from souschef.converters.habitat import (
     generate_compose_from_habitat,
 )
 from souschef.converters.playbook import (
-    analyze_chef_search_patterns,
+    analyse_chef_search_patterns,
     convert_chef_search_to_inventory,
     generate_dynamic_inventory_script,
     generate_playbook_from_recipe,
@@ -17,7 +17,7 @@ __all__ = [
     "generate_playbook_from_recipe",
     "convert_chef_search_to_inventory",
     "generate_dynamic_inventory_script",
-    "analyze_chef_search_patterns",
+    "analyse_chef_search_patterns",
     "convert_habitat_to_dockerfile",
     "generate_compose_from_habitat",
 ]