PyPI - runbooks - Versions diffs - 0.2.5__py3-none-any.whl → 0.7.0__py3-none-any.whl - Mend

runbooks 0.2.5py3-none-any.whl → 0.7.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (249) hide show

conftest.py +26 -0
jupyter-agent/.env +2 -0
jupyter-agent/.env.template +2 -0
jupyter-agent/.gitattributes +35 -0
jupyter-agent/.gradio/certificate.pem +31 -0
jupyter-agent/README.md +16 -0
jupyter-agent/__main__.log +8 -0
jupyter-agent/app.py +256 -0
jupyter-agent/cloudops-agent.png +0 -0
jupyter-agent/ds-system-prompt.txt +154 -0
jupyter-agent/jupyter-agent.png +0 -0
jupyter-agent/llama3_template.jinja +123 -0
jupyter-agent/requirements.txt +9 -0
jupyter-agent/tmp/4ojbs8a02ir/jupyter-agent.ipynb +68 -0
jupyter-agent/tmp/cm5iasgpm3p/jupyter-agent.ipynb +91 -0
jupyter-agent/tmp/crqbsseag5/jupyter-agent.ipynb +91 -0
jupyter-agent/tmp/hohanq1u097/jupyter-agent.ipynb +57 -0
jupyter-agent/tmp/jns1sam29wm/jupyter-agent.ipynb +53 -0
jupyter-agent/tmp/jupyter-agent.ipynb +27 -0
jupyter-agent/utils.py +409 -0
runbooks/__init__.py +71 -3
runbooks/__main__.py +13 -0
runbooks/aws/ec2_describe_instances.py +1 -1
runbooks/aws/ec2_run_instances.py +8 -2
runbooks/aws/ec2_start_stop_instances.py +17 -4
runbooks/aws/ec2_unused_volumes.py +5 -1
runbooks/aws/s3_create_bucket.py +4 -2
runbooks/aws/s3_list_objects.py +6 -1
runbooks/aws/tagging_lambda_handler.py +13 -2
runbooks/aws/tags.json +12 -0
runbooks/base.py +353 -0
runbooks/cfat/README.md +49 -0
runbooks/cfat/__init__.py +74 -0
runbooks/cfat/app.ts +644 -0
runbooks/cfat/assessment/__init__.py +40 -0
runbooks/cfat/assessment/asana-import.csv +39 -0
runbooks/cfat/assessment/cfat-checks.csv +31 -0
runbooks/cfat/assessment/cfat.txt +520 -0
runbooks/cfat/assessment/collectors.py +200 -0
runbooks/cfat/assessment/jira-import.csv +39 -0
runbooks/cfat/assessment/runner.py +387 -0
runbooks/cfat/assessment/validators.py +290 -0
runbooks/cfat/cli.py +103 -0
runbooks/cfat/docs/asana-import.csv +24 -0
runbooks/cfat/docs/cfat-checks.csv +31 -0
runbooks/cfat/docs/cfat.txt +335 -0
runbooks/cfat/docs/checks-output.png +0 -0
runbooks/cfat/docs/cloudshell-console-run.png +0 -0
runbooks/cfat/docs/cloudshell-download.png +0 -0
runbooks/cfat/docs/cloudshell-output.png +0 -0
runbooks/cfat/docs/downloadfile.png +0 -0
runbooks/cfat/docs/jira-import.csv +24 -0
runbooks/cfat/docs/open-cloudshell.png +0 -0
runbooks/cfat/docs/report-header.png +0 -0
runbooks/cfat/models.py +1026 -0
runbooks/cfat/package-lock.json +5116 -0
runbooks/cfat/package.json +38 -0
runbooks/cfat/report.py +496 -0
runbooks/cfat/reporting/__init__.py +46 -0
runbooks/cfat/reporting/exporters.py +337 -0
runbooks/cfat/reporting/formatters.py +496 -0
runbooks/cfat/reporting/templates.py +135 -0
runbooks/cfat/run-assessment.sh +23 -0
runbooks/cfat/runner.py +69 -0
runbooks/cfat/src/actions/check-cloudtrail-existence.ts +43 -0
runbooks/cfat/src/actions/check-config-existence.ts +37 -0
runbooks/cfat/src/actions/check-control-tower.ts +37 -0
runbooks/cfat/src/actions/check-ec2-existence.ts +46 -0
runbooks/cfat/src/actions/check-iam-users.ts +50 -0
runbooks/cfat/src/actions/check-legacy-cur.ts +30 -0
runbooks/cfat/src/actions/check-org-cloudformation.ts +30 -0
runbooks/cfat/src/actions/check-vpc-existence.ts +43 -0
runbooks/cfat/src/actions/create-asanaimport.ts +14 -0
runbooks/cfat/src/actions/create-backlog.ts +372 -0
runbooks/cfat/src/actions/create-jiraimport.ts +15 -0
runbooks/cfat/src/actions/create-report.ts +616 -0
runbooks/cfat/src/actions/define-account-type.ts +51 -0
runbooks/cfat/src/actions/get-enabled-org-policy-types.ts +40 -0
runbooks/cfat/src/actions/get-enabled-org-services.ts +26 -0
runbooks/cfat/src/actions/get-idc-info.ts +34 -0
runbooks/cfat/src/actions/get-org-da-accounts.ts +34 -0
runbooks/cfat/src/actions/get-org-details.ts +35 -0
runbooks/cfat/src/actions/get-org-member-accounts.ts +44 -0
runbooks/cfat/src/actions/get-org-ous.ts +35 -0
runbooks/cfat/src/actions/get-regions.ts +22 -0
runbooks/cfat/src/actions/zip-assessment.ts +27 -0
runbooks/cfat/src/types/index.d.ts +147 -0
runbooks/cfat/tests/__init__.py +141 -0
runbooks/cfat/tests/test_cli.py +340 -0
runbooks/cfat/tests/test_integration.py +290 -0
runbooks/cfat/tests/test_models.py +505 -0
runbooks/cfat/tests/test_reporting.py +354 -0
runbooks/cfat/tsconfig.json +16 -0
runbooks/cfat/webpack.config.cjs +27 -0
runbooks/config.py +260 -0
runbooks/finops/README.md +337 -0
runbooks/finops/__init__.py +86 -0
runbooks/finops/aws_client.py +245 -0
runbooks/finops/cli.py +151 -0
runbooks/finops/cost_processor.py +410 -0
runbooks/finops/dashboard_runner.py +448 -0
runbooks/finops/helpers.py +355 -0
runbooks/finops/main.py +14 -0
runbooks/finops/profile_processor.py +174 -0
runbooks/finops/types.py +66 -0
runbooks/finops/visualisations.py +80 -0
runbooks/inventory/.gitignore +354 -0
runbooks/inventory/ArgumentsClass.py +261 -0
runbooks/inventory/FAILED_SCRIPTS_TROUBLESHOOTING.md +619 -0
runbooks/inventory/Inventory_Modules.py +6130 -0
runbooks/inventory/LandingZone/delete_lz.py +1075 -0
runbooks/inventory/PASSED_SCRIPTS_GUIDE.md +738 -0
runbooks/inventory/README.md +1320 -0
runbooks/inventory/__init__.py +62 -0
runbooks/inventory/account_class.py +532 -0
runbooks/inventory/all_my_instances_wrapper.py +123 -0
runbooks/inventory/aws_decorators.py +201 -0
runbooks/inventory/aws_organization.png +0 -0
runbooks/inventory/cfn_move_stack_instances.py +1526 -0
runbooks/inventory/check_cloudtrail_compliance.py +614 -0
runbooks/inventory/check_controltower_readiness.py +1107 -0
runbooks/inventory/check_landingzone_readiness.py +711 -0
runbooks/inventory/cloudtrail.md +727 -0
runbooks/inventory/collectors/__init__.py +20 -0
runbooks/inventory/collectors/aws_compute.py +518 -0
runbooks/inventory/collectors/aws_networking.py +275 -0
runbooks/inventory/collectors/base.py +222 -0
runbooks/inventory/core/__init__.py +19 -0
runbooks/inventory/core/collector.py +303 -0
runbooks/inventory/core/formatter.py +296 -0
runbooks/inventory/delete_s3_buckets_objects.py +169 -0
runbooks/inventory/discovery.md +81 -0
runbooks/inventory/draw_org_structure.py +748 -0
runbooks/inventory/ec2_vpc_utils.py +341 -0
runbooks/inventory/find_cfn_drift_detection.py +272 -0
runbooks/inventory/find_cfn_orphaned_stacks.py +719 -0
runbooks/inventory/find_cfn_stackset_drift.py +733 -0
runbooks/inventory/find_ec2_security_groups.py +669 -0
runbooks/inventory/find_landingzone_versions.py +201 -0
runbooks/inventory/find_vpc_flow_logs.py +1221 -0
runbooks/inventory/inventory.sh +659 -0
runbooks/inventory/list_cfn_stacks.py +558 -0
runbooks/inventory/list_cfn_stackset_operation_results.py +252 -0
runbooks/inventory/list_cfn_stackset_operations.py +734 -0
runbooks/inventory/list_cfn_stacksets.py +453 -0
runbooks/inventory/list_config_recorders_delivery_channels.py +681 -0
runbooks/inventory/list_ds_directories.py +354 -0
runbooks/inventory/list_ec2_availability_zones.py +286 -0
runbooks/inventory/list_ec2_ebs_volumes.py +244 -0
runbooks/inventory/list_ec2_instances.py +425 -0
runbooks/inventory/list_ecs_clusters_and_tasks.py +562 -0
runbooks/inventory/list_elbs_load_balancers.py +411 -0
runbooks/inventory/list_enis_network_interfaces.py +526 -0
runbooks/inventory/list_guardduty_detectors.py +568 -0
runbooks/inventory/list_iam_policies.py +404 -0
runbooks/inventory/list_iam_roles.py +518 -0
runbooks/inventory/list_iam_saml_providers.py +359 -0
runbooks/inventory/list_lambda_functions.py +882 -0
runbooks/inventory/list_org_accounts.py +446 -0
runbooks/inventory/list_org_accounts_users.py +354 -0
runbooks/inventory/list_rds_db_instances.py +406 -0
runbooks/inventory/list_route53_hosted_zones.py +318 -0
runbooks/inventory/list_servicecatalog_provisioned_products.py +575 -0
runbooks/inventory/list_sns_topics.py +360 -0
runbooks/inventory/list_ssm_parameters.py +402 -0
runbooks/inventory/list_vpc_subnets.py +433 -0
runbooks/inventory/list_vpcs.py +422 -0
runbooks/inventory/lockdown_cfn_stackset_role.py +224 -0
runbooks/inventory/models/__init__.py +24 -0
runbooks/inventory/models/account.py +192 -0
runbooks/inventory/models/inventory.py +309 -0
runbooks/inventory/models/resource.py +247 -0
runbooks/inventory/recover_cfn_stack_ids.py +205 -0
runbooks/inventory/requirements.txt +12 -0
runbooks/inventory/run_on_multi_accounts.py +211 -0
runbooks/inventory/tests/common_test_data.py +3661 -0
runbooks/inventory/tests/common_test_functions.py +204 -0
runbooks/inventory/tests/setup.py +24 -0
runbooks/inventory/tests/src.py +18 -0
runbooks/inventory/tests/test_cfn_describe_stacks.py +208 -0
runbooks/inventory/tests/test_ec2_describe_instances.py +162 -0
runbooks/inventory/tests/test_inventory_modules.py +55 -0
runbooks/inventory/tests/test_lambda_list_functions.py +86 -0
runbooks/inventory/tests/test_moto_integration_example.py +273 -0
runbooks/inventory/tests/test_org_list_accounts.py +49 -0
runbooks/inventory/update_aws_actions.py +173 -0
runbooks/inventory/update_cfn_stacksets.py +1215 -0
runbooks/inventory/update_cloudwatch_logs_retention_policy.py +294 -0
runbooks/inventory/update_iam_roles_cross_accounts.py +478 -0
runbooks/inventory/update_s3_public_access_block.py +539 -0
runbooks/inventory/utils/__init__.py +23 -0
runbooks/inventory/utils/aws_helpers.py +510 -0
runbooks/inventory/utils/threading_utils.py +493 -0
runbooks/inventory/utils/validation.py +682 -0
runbooks/inventory/verify_ec2_security_groups.py +1430 -0
runbooks/main.py +1004 -0
runbooks/organizations/__init__.py +12 -0
runbooks/organizations/manager.py +374 -0
runbooks/security/README.md +447 -0
runbooks/security/__init__.py +71 -0
runbooks/{security_baseline → security}/checklist/alternate_contacts.py +8 -1
runbooks/{security_baseline → security}/checklist/bucket_public_access.py +4 -1
runbooks/{security_baseline → security}/checklist/cloudwatch_alarm_configuration.py +9 -2
runbooks/{security_baseline → security}/checklist/guardduty_enabled.py +9 -2
runbooks/{security_baseline → security}/checklist/multi_region_instance_usage.py +5 -1
runbooks/{security_baseline → security}/checklist/root_access_key.py +6 -1
runbooks/{security_baseline → security}/config-origin.json +1 -1
runbooks/{security_baseline → security}/config.json +1 -1
runbooks/{security_baseline → security}/permission.json +1 -1
runbooks/{security_baseline → security}/report_generator.py +10 -2
runbooks/{security_baseline → security}/report_template_en.html +7 -7
runbooks/{security_baseline → security}/report_template_jp.html +7 -7
runbooks/{security_baseline → security}/report_template_kr.html +12 -12
runbooks/{security_baseline → security}/report_template_vn.html +7 -7
runbooks/{security_baseline → security}/run_script.py +8 -2
runbooks/{security_baseline → security}/security_baseline_tester.py +12 -4
runbooks/{security_baseline → security}/utils/common.py +5 -1
runbooks/utils/__init__.py +204 -0
runbooks-0.7.0.dist-info/METADATA +375 -0
runbooks-0.7.0.dist-info/RECORD +249 -0
{runbooks-0.2.5.dist-info → runbooks-0.7.0.dist-info}/WHEEL +1 -1
runbooks-0.7.0.dist-info/entry_points.txt +7 -0
runbooks-0.7.0.dist-info/licenses/LICENSE +201 -0
runbooks-0.7.0.dist-info/top_level.txt +3 -0
runbooks/python101/calculator.py +0 -34
runbooks/python101/config.py +0 -1
runbooks/python101/exceptions.py +0 -16
runbooks/python101/file_manager.py +0 -218
runbooks/python101/toolkit.py +0 -153
runbooks-0.2.5.dist-info/METADATA +0 -439
runbooks-0.2.5.dist-info/RECORD +0 -61
runbooks-0.2.5.dist-info/entry_points.txt +0 -3
runbooks-0.2.5.dist-info/top_level.txt +0 -1
/runbooks/{security_baseline/__init__.py → inventory/tests/script_test_data.py} +0 -0
/runbooks/{security_baseline → security}/checklist/__init__.py +0 -0
/runbooks/{security_baseline → security}/checklist/account_level_bucket_public_access.py +0 -0
/runbooks/{security_baseline → security}/checklist/direct_attached_policy.py +0 -0
/runbooks/{security_baseline → security}/checklist/iam_password_policy.py +0 -0
/runbooks/{security_baseline → security}/checklist/iam_user_mfa.py +0 -0
/runbooks/{security_baseline → security}/checklist/multi_region_trail.py +0 -0
/runbooks/{security_baseline → security}/checklist/root_mfa.py +0 -0
/runbooks/{security_baseline → security}/checklist/root_usage.py +0 -0
/runbooks/{security_baseline → security}/checklist/trail_enabled.py +0 -0
/runbooks/{security_baseline → security}/checklist/trusted_advisor.py +0 -0
/runbooks/{security_baseline → security}/utils/__init__.py +0 -0
/runbooks/{security_baseline → security}/utils/enums.py +0 -0
/runbooks/{security_baseline → security}/utils/language.py +0 -0
/runbooks/{security_baseline → security}/utils/level_const.py +0 -0
/runbooks/{security_baseline → security}/utils/permission_list.py +0 -0

runbooks/cfat/tests/test_reporting.py ADDED Viewed

@@ -0,0 +1,354 @@
+"""
+Tests for CFAT reporting functionality.
+Tests report generation, export formats, and project management
+integrations to ensure reliable multi-format output generation.
+"""
+import csv
+import json
+import os
+import tempfile
+from io import StringIO
+from pathlib import Path
+import pytest
+from runbooks.cfat.models import AssessmentReport, CheckStatus, Severity
+from runbooks.cfat.reporting.exporters import (
+    AsanaExporter,
+    JiraExporter,
+    ServiceNowExporter,
+    get_exporter,
+    list_available_exporters,
+)
+from runbooks.cfat.tests import create_sample_assessment_report
+@pytest.mark.reporting
+class TestReportGeneration:
+    """Test assessment report generation in various formats."""
+    def setup_method(self):
+        """Set up test environment."""
+        self.report = create_sample_assessment_report(num_results=10)
+        self.temp_dir = tempfile.mkdtemp()
+    def teardown_method(self):
+        """Clean up test environment."""
+        import shutil
+        shutil.rmtree(self.temp_dir, ignore_errors=True)
+    def test_json_export(self):
+        """Test JSON report generation."""
+        json_file = os.path.join(self.temp_dir, "test_report.json")
+        # Generate JSON report
+        self.report.to_json(json_file)
+        # Verify file was created
+        assert os.path.exists(json_file)
+        # Verify JSON content
+        with open(json_file, "r") as f:
+            data = json.load(f)
+        assert data["account_id"] == self.report.account_id
+        assert data["region"] == self.report.region
+        assert len(data["results"]) == len(self.report.results)
+        assert "summary" in data
+        assert data["summary"]["total_checks"] == self.report.summary.total_checks
+    def test_csv_export(self):
+        """Test CSV report generation."""
+        csv_file = os.path.join(self.temp_dir, "test_report.csv")
+        # Generate CSV report
+        self.report.to_csv(csv_file)
+        # Verify file was created
+        assert os.path.exists(csv_file)
+        # Verify CSV content
+        with open(csv_file, "r") as f:
+            reader = csv.DictReader(f)
+            rows = list(reader)
+        assert len(rows) == len(self.report.results)
+        # Check required columns
+        expected_columns = ["finding_id", "check_name", "category", "status", "severity", "message", "execution_time"]
+        for col in expected_columns:
+            assert col in reader.fieldnames
+        # Verify data integrity
+        first_row = rows[0]
+        first_result = self.report.results[0]
+        assert first_row["finding_id"] == first_result.finding_id
+        assert first_row["check_name"] == first_result.check_name
+        assert first_row["status"] == first_result.status.value
+    def test_html_export(self):
+        """Test HTML report generation."""
+        html_file = os.path.join(self.temp_dir, "test_report.html")
+        # Generate HTML report
+        self.report.to_html(html_file)
+        # Verify file was created
+        assert os.path.exists(html_file)
+        # Verify HTML content
+        with open(html_file, "r") as f:
+            html_content = f.read()
+        assert "<!DOCTYPE html>" in html_content
+        assert "Cloud Foundations Assessment Report" in html_content
+        assert self.report.account_id in html_content
+        assert str(self.report.summary.total_checks) in html_content
+    def test_markdown_export(self):
+        """Test Markdown report generation."""
+        md_file = os.path.join(self.temp_dir, "test_report.md")
+        # Generate Markdown report
+        self.report.to_markdown(md_file)
+        # Verify file was created
+        assert os.path.exists(md_file)
+        # Verify Markdown content
+        with open(md_file, "r") as f:
+            md_content = f.read()
+        assert "# Cloud Foundations Assessment Report" in md_content
+        assert f"**Account:** {self.report.account_id}" in md_content
+        assert f"**Total Checks:** {self.report.summary.total_checks}" in md_content
+        assert f"**Compliance Score:** {self.report.summary.compliance_score}" in md_content
+    def test_export_with_failed_results(self):
+        """Test export handling when there are failed results."""
+        # Create report with failed results
+        from runbooks.cfat.tests import create_sample_assessment_result
+        failed_result = create_sample_assessment_result(
+            finding_id="FAIL-001",
+            status=CheckStatus.FAIL,
+            severity=Severity.CRITICAL,
+            message="Critical security issue",
+            check_name="security_check",
+        )
+        # Add to report
+        self.report.results.append(failed_result)
+        # Test markdown export shows critical findings
+        md_file = os.path.join(self.temp_dir, "failed_report.md")
+        self.report.to_markdown(md_file)
+        with open(md_file, "r") as f:
+            content = f.read()
+        assert "🚨 Critical Findings" in content
+        assert "FAIL-001" in content
+@pytest.mark.reporting
+class TestProjectManagementExporters:
+    """Test project management tool exporters."""
+    def setup_method(self):
+        """Set up test environment."""
+        # Create report with some failed results for export
+        self.report = create_sample_assessment_report(num_results=5)
+        # Ensure we have some failed results
+        from runbooks.cfat.tests import create_sample_assessment_result
+        failed_result = create_sample_assessment_result(
+            finding_id="CRITICAL-001",
+            status=CheckStatus.FAIL,
+            severity=Severity.CRITICAL,
+            message="Critical security vulnerability requires immediate attention",
+            check_name="security_critical_check",
+        )
+        failed_result.recommendations = ["Enable MFA for root account", "Review IAM policies for least privilege"]
+        self.report.results.append(failed_result)
+        self.temp_dir = tempfile.mkdtemp()
+    def teardown_method(self):
+        """Clean up test environment."""
+        import shutil
+        shutil.rmtree(self.temp_dir, ignore_errors=True)
+    def test_jira_exporter(self):
+        """Test Jira CSV export functionality."""
+        exporter = JiraExporter()
+        assert exporter.get_exporter_name() == "jira"
+        # Test export to file
+        jira_file = os.path.join(self.temp_dir, "jira_export.csv")
+        csv_content = exporter.export(self.report, jira_file)
+        # Verify file was created
+        assert os.path.exists(jira_file)
+        # Verify CSV content structure
+        assert isinstance(csv_content, str)
+        assert "Summary,Issue Type,Priority" in csv_content
+        assert "[CFAT]" in csv_content
+        # Parse CSV to verify structure
+        csv_reader = csv.DictReader(StringIO(csv_content))
+        rows = list(csv_reader)
+        # Should have at least one row for failed results
+        failed_results = self.report.get_failed_results()
+        assert len(rows) >= len(failed_results)
+        # Check required Jira columns
+        expected_columns = ["Summary", "Issue Type", "Priority", "Description", "Labels"]
+        for col in expected_columns:
+            assert col in csv_reader.fieldnames
+    def test_asana_exporter(self):
+        """Test Asana CSV export functionality."""
+        exporter = AsanaExporter()
+        assert exporter.get_exporter_name() == "asana"
+        # Test export
+        asana_file = os.path.join(self.temp_dir, "asana_export.csv")
+        csv_content = exporter.export(self.report, asana_file)
+        # Verify file and content
+        assert os.path.exists(asana_file)
+        assert isinstance(csv_content, str)
+        assert "Name,Notes,Priority" in csv_content
+        # Parse and verify structure
+        csv_reader = csv.DictReader(StringIO(csv_content))
+        rows = list(csv_reader)
+        assert len(rows) > 0
+        # Check Asana-specific columns
+        expected_columns = ["Name", "Notes", "Priority", "Tags", "Due Date"]
+        for col in expected_columns:
+            assert col in csv_reader.fieldnames
+    def test_servicenow_exporter(self):
+        """Test ServiceNow JSON export functionality."""
+        exporter = ServiceNowExporter()
+        assert exporter.get_exporter_name() == "servicenow"
+        # Test export
+        snow_file = os.path.join(self.temp_dir, "servicenow_export.json")
+        json_content = exporter.export(self.report, snow_file)
+        # Verify file and content
+        assert os.path.exists(snow_file)
+        assert isinstance(json_content, str)
+        # Parse JSON to verify structure
+        data = json.loads(json_content)
+        assert "incidents" in data
+        assert "metadata" in data
+        # Verify incident structure
+        incidents = data["incidents"]
+        assert len(incidents) > 0
+        incident = incidents[0]
+        required_fields = ["short_description", "description", "category", "priority", "impact", "urgency"]
+        for field in required_fields:
+            assert field in incident
+        # Verify metadata
+        metadata = data["metadata"]
+        assert metadata["account_id"] == self.report.account_id
+        assert "assessment_date" in metadata
+    def test_severity_mapping(self):
+        """Test severity to priority mapping in exporters."""
+        jira_exporter = JiraExporter()
+        # Test severity mapping
+        assert jira_exporter._map_severity_to_priority(Severity.CRITICAL) == "Critical"
+        assert jira_exporter._map_severity_to_priority(Severity.WARNING) == "High"
+        assert jira_exporter._map_severity_to_priority(Severity.INFO) == "Medium"
+    def test_exporter_registry(self):
+        """Test exporter registry functionality."""
+        # Test getting exporters by name
+        jira_exporter = get_exporter("jira")
+        assert isinstance(jira_exporter, JiraExporter)
+        asana_exporter = get_exporter("asana")
+        assert isinstance(asana_exporter, AsanaExporter)
+        snow_exporter = get_exporter("servicenow")
+        assert isinstance(snow_exporter, ServiceNowExporter)
+        # Test invalid exporter
+        invalid_exporter = get_exporter("invalid")
+        assert invalid_exporter is None
+        # Test listing available exporters
+        available = list_available_exporters()
+        assert "jira" in available
+        assert "asana" in available
+        assert "servicenow" in available
+    def test_export_with_no_failed_results(self):
+        """Test exporters handle reports with no failed results gracefully."""
+        # Create report with only passed results
+        from runbooks.cfat.tests import create_sample_assessment_result
+        passed_report = create_sample_assessment_report(num_results=0)
+        passed_result = create_sample_assessment_result(status=CheckStatus.PASS, severity=Severity.INFO)
+        passed_report.results = [passed_result]
+        # Test Jira exporter
+        jira_exporter = JiraExporter()
+        jira_file = os.path.join(self.temp_dir, "jira_empty.csv")
+        csv_content = jira_exporter.export(passed_report, jira_file)
+        # Should still create file with headers but no data rows
+        assert os.path.exists(jira_file)
+        csv_reader = csv.DictReader(StringIO(csv_content))
+        rows = list(csv_reader)
+        assert len(rows) == 0  # No failed results to export
+    def test_large_export(self):
+        """Test exporters handle large numbers of findings."""
+        # Create report with many failed results
+        large_report = create_sample_assessment_report(num_results=0)
+        from runbooks.cfat.tests import create_sample_assessment_result
+        for i in range(100):
+            failed_result = create_sample_assessment_result(
+                finding_id=f"LARGE-{i:03d}",
+                status=CheckStatus.FAIL,
+                severity=Severity.WARNING,
+                message=f"Large test finding {i}",
+                check_name=f"large_check_{i}",
+            )
+            large_report.results.append(failed_result)
+        # Test Jira export handles large data
+        jira_exporter = JiraExporter()
+        jira_file = os.path.join(self.temp_dir, "jira_large.csv")
+        csv_content = jira_exporter.export(large_report, jira_file)
+        # Verify all results were exported
+        csv_reader = csv.DictReader(StringIO(csv_content))
+        rows = list(csv_reader)
+        assert len(rows) == 100
+        # Verify file size is reasonable
+        file_size = os.path.getsize(jira_file)
+        assert file_size > 1000  # Should be substantial but not enormous
+        assert file_size < 1000000  # Should be less than 1MB

runbooks/cfat/tsconfig.json ADDED Viewed

@@ -0,0 +1,16 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "ES2020",
+		"strict": true,
+		"preserveConstEnums": true,
+		"sourceMap": false,
+		"outDir": "./build",
+		"moduleResolution": "node",
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true
+	},
+	"include": ["src/**/*", "./**/*.ts"],
+	"exclude": ["node_modules", "**/*.test.ts"]
+}

runbooks/cfat/webpack.config.cjs ADDED Viewed

@@ -0,0 +1,27 @@
+//import * as path from 'path'
+const path = require('path');
+const nodeExternals = require('webpack-node-externals');
+module.exports = {
+   target: 'node',
+   entry: './build/app.js',
+   externals: [nodeExternals()],
+   mode: 'production',
+   devtool: 'inline-source-map',
+   watch: false,
+   output: {
+      filename: 'cfat.js',
+      path: path.resolve(__dirname, 'dist'),
+   },
+   resolve: {
+      extensions: ['.ts', '.js'],
+   },
+   module: {
+      rules: [
+         {
+            test: /\.ts$/,
+            use: 'ts-loader',
+            exclude: /node_modules/,
+         },
+      ],
+   },
+};

runbooks/config.py ADDED Viewed

@@ -0,0 +1,260 @@
+"""
+Configuration management for CloudOps Runbooks.
+This module handles loading, saving, and managing configuration settings
+for the runbooks package, including AWS profiles, regions, and assessment settings.
+"""
+import os
+from pathlib import Path
+from typing import Any, Dict, Optional
+import yaml
+from loguru import logger
+try:
+    from pydantic import BaseModel, Field
+    _HAS_PYDANTIC = True
+except ImportError:
+    _HAS_PYDANTIC = False
+    # Fallback BaseModel
+    class BaseModel:
+        def __init__(self, **kwargs):
+            for key, value in kwargs.items():
+                setattr(self, key, value)
+        def model_dump(self, exclude_none=True):
+            result = {}
+            for key, value in self.__dict__.items():
+                if not exclude_none or value is not None:
+                    result[key] = value
+            return result
+    def Field(default=None, default_factory=None, description=""):
+        if default_factory:
+            return default_factory()
+        return default
+from runbooks.utils import ensure_directory
+class RunbooksConfig(BaseModel):
+    """Configuration model for CloudOps Runbooks."""
+    # AWS Configuration
+    aws_profile: str = Field(default="default", description="Default AWS profile")
+    aws_region: Optional[str] = Field(default=None, description="Default AWS region")
+    # Assessment Configuration
+    cfat_checks: Dict[str, bool] = Field(
+        default_factory=lambda: {
+            "cloudtrail": True,
+            "config": True,
+            "iam": True,
+            "vpc": True,
+            "ec2": True,
+            "organizations": True,
+            "control_tower": True,
+            "kms": True,
+        },
+        description="CFAT checks to run by default",
+    )
+    cfat_severity_threshold: str = Field(default="WARNING", description="Minimum severity for CFAT reports")
+    # Inventory Configuration
+    inventory_parallel: bool = Field(default=True, description="Run inventory collection in parallel")
+    inventory_cache_ttl: int = Field(default=3600, description="Inventory cache TTL in seconds")
+    inventory_include_costs: bool = Field(default=False, description="Include cost data in inventory")
+    # Output Configuration
+    default_output_format: str = Field(default="console", description="Default output format")
+    reports_directory: str = Field(default="reports", description="Directory for generated reports")
+    # Logging Configuration
+    log_level: str = Field(default="INFO", description="Default log level")
+    log_file: Optional[str] = Field(default=None, description="Log file path")
+    class Config:
+        """Pydantic config."""
+        extra = "allow"
+def get_default_config_path() -> Path:
+    """
+    Get the default configuration file path.
+    Returns:
+        Path to the default config file
+    """
+    config_dir = Path.home() / ".runbooks"
+    ensure_directory(config_dir)
+    return config_dir / "config.yaml"
+def load_config(config_path: Optional[Path] = None) -> RunbooksConfig:
+    """
+    Load configuration from file or return default configuration.
+    Args:
+        config_path: Path to configuration file
+    Returns:
+        Loaded configuration object
+    """
+    if config_path is None:
+        config_path = get_default_config_path()
+    if not config_path.exists():
+        logger.info(f"Config file not found at {config_path}, using defaults")
+        config = RunbooksConfig()
+        save_config(config, config_path)
+        return config
+    try:
+        with open(config_path, "r", encoding="utf-8") as f:
+            config_data = yaml.safe_load(f) or {}
+        # Handle environment variable substitution
+        config_data = _substitute_env_vars(config_data)
+        config = RunbooksConfig(**config_data)
+        logger.debug(f"Loaded configuration from {config_path}")
+        return config
+    except Exception as e:
+        logger.error(f"Error loading config from {config_path}: {e}")
+        logger.info("Using default configuration")
+        return RunbooksConfig()
+def save_config(config: RunbooksConfig, config_path: Optional[Path] = None) -> None:
+    """
+    Save configuration to file.
+    Args:
+        config: Configuration object to save
+        config_path: Path to save configuration file
+    """
+    if config_path is None:
+        config_path = get_default_config_path()
+    try:
+        ensure_directory(config_path.parent)
+        config_dict = config.model_dump(exclude_none=True)
+        with open(config_path, "w", encoding="utf-8") as f:
+            yaml.dump(config_dict, f, default_flow_style=False, indent=2, sort_keys=True)
+        logger.debug(f"Saved configuration to {config_path}")
+    except Exception as e:
+        logger.error(f"Error saving config to {config_path}: {e}")
+        raise
+def update_config(updates: Dict[str, Any], config_path: Optional[Path] = None) -> RunbooksConfig:
+    """
+    Update specific configuration values.
+    Args:
+        updates: Dictionary of configuration updates
+        config_path: Path to configuration file
+    Returns:
+        Updated configuration object
+    """
+    config = load_config(config_path)
+    # Update configuration
+    for key, value in updates.items():
+        if hasattr(config, key):
+            setattr(config, key, value)
+        else:
+            logger.warning(f"Unknown configuration key: {key}")
+    save_config(config, config_path)
+    return config
+def _substitute_env_vars(data: Any) -> Any:
+    """
+    Recursively substitute environment variables in configuration data.
+    Args:
+        data: Configuration data
+    Returns:
+        Data with environment variables substituted
+    """
+    if isinstance(data, dict):
+        return {key: _substitute_env_vars(value) for key, value in data.items()}
+    elif isinstance(data, list):
+        return [_substitute_env_vars(item) for item in data]
+    elif isinstance(data, str):
+        # Simple environment variable substitution ${VAR_NAME}
+        if data.startswith("${") and data.endswith("}"):
+            env_var = data[2:-1]
+            return os.getenv(env_var, data)
+        return data
+    else:
+        return data
+def get_aws_session_config(config: RunbooksConfig) -> Dict[str, str]:
+    """
+    Get AWS session configuration from runbooks config.
+    Args:
+        config: Runbooks configuration
+    Returns:
+        Dictionary with AWS session parameters
+    """
+    session_config = {"profile_name": config.aws_profile}
+    if config.aws_region:
+        session_config["region_name"] = config.aws_region
+    return session_config
+def validate_config(config: RunbooksConfig) -> bool:
+    """
+    Validate configuration settings.
+    Args:
+        config: Configuration to validate
+    Returns:
+        True if configuration is valid
+    """
+    try:
+        # Validate AWS profile if specified
+        if config.aws_profile != "default":
+            from runbooks.utils import validate_aws_profile
+            if not validate_aws_profile(config.aws_profile):
+                logger.warning(f"AWS profile '{config.aws_profile}' not found")
+        # Validate log level
+        valid_levels = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+        if config.log_level not in valid_levels:
+            logger.warning(f"Invalid log level '{config.log_level}', using INFO")
+            config.log_level = "INFO"
+        # Validate severity threshold
+        valid_severities = ["INFO", "WARNING", "CRITICAL"]
+        if config.cfat_severity_threshold not in valid_severities:
+            logger.warning(f"Invalid CFAT severity '{config.cfat_severity_threshold}', using WARNING")
+            config.cfat_severity_threshold = "WARNING"
+        return True
+    except Exception as e:
+        logger.error(f"Configuration validation failed: {e}")
+        return False

runbooks 0.2.5__py3-none-any.whl → 0.7.0__py3-none-any.whl

runbooks 0.2.5py3-none-any.whl → 0.7.0py3-none-any.whl