regscale-cli 6.23.0.1__py3-none-any.whl → 6.24.0.0__py3-none-any.whl

tests/regscale/integrations/public/test_emass.py

@@ -0,0 +1,518 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Test eMASS Integration"""
+
+import os
+import sys
+import tempfile
+from pathlib import Path
+
+import pytest
+import pandas as pd
+from click.testing import CliRunner
+from openpyxl import Workbook
+from openpyxl.reader.excel import load_workbook
+from openpyxl.styles import PatternFill
+from openpyxl.comments import Comment
+import unittest.mock as mock
+
+import regscale.integrations.public.emass as emass_mod
+from regscale.integrations.public.emass import (
+    populate_assessment_results,
+    populate_emass_workbook,
+    import_emass_slcm_file,
+    determine_assessment_result,
+    map_finish_date,
+    map_ccis,
+    fetch_template_from_blob,
+    populate_emass_workbook,
+    SKIP_ROWS,
+)
+from tests import CLITestFixture
+
+
+class TestEmass(CLITestFixture):
+    """Integration, unit, and CLI callback tests for the eMASS CLI integration logic."""
+
+    @pytest.fixture(autouse=True)
+    def setup_test_environment(self, create_security_plan):
+        """Setup test environment with dynamic security plan creation."""
+        self.security_plan = create_security_plan
+        self.template_workbook = ""
+        self.output_workbook = Path()
+        yield
+        # Cleanup will be handled by create_security_plan fixture
+
+    @pytest.fixture(autouse=True)
+    def patch_dependencies(self, tmp_path):
+        """Patches I/O and external fetch logic to isolate tests from real API or filesystem."""
+        with mock.patch.object(
+            emass_mod,
+            "fetch_assessments_and_controls",
+            side_effect=lambda ssp_id, api: [
+                {
+                    "ccis": ["CCI-123456"],
+                    "assessments": [
+                        {
+                            "id": 1,
+                            "actualFinish": "2024-01-01",
+                            "assessmentResult": "Pass",
+                            "summaryOfResults": "OK",
+                            "leadAssessor": {"firstName": "Test", "lastName": "User"},
+                        }
+                    ],
+                }
+            ],
+        ), mock.patch.object(
+            emass_mod, "check_file_path", side_effect=lambda path: Path(path).mkdir(exist_ok=True)
+        ), mock.patch.object(
+            pd, "read_excel", side_effect=lambda file, skiprows: pd.DataFrame({"CCI": [123456]})
+        ):
+            yield
+
+    def create_template(self):
+        """Creates a temporary Excel file with mock CCI data."""
+        tmp_file = tempfile.NamedTemporaryFile(delete=False, suffix=".xlsx")
+        wb = Workbook()
+        ws = wb.active
+        for _ in range(SKIP_ROWS - 2):
+            ws.append([])
+        ws.append(["CCI"])
+        ws.append([123456])
+        wb.save(tmp_file.name)
+        tmp_file.close()
+        self.template_workbook = tmp_file.name
+
+    def populate_controls(self):
+        """Populates the output workbook using mock API and template."""
+        self.output_workbook = populate_assessment_results(
+            file_name=Path(self.template_workbook),
+            ssp_id=self.security_plan.id,
+            api=self.api,
+        )
+
+    def check_values(self):
+        """Verifies that output cells M and O are filled for at least one row."""
+        pass_flag = False
+        wb = load_workbook(self.output_workbook)
+        sheet = wb.active
+        for row in range(SKIP_ROWS, sheet.max_row + 1):
+            if sheet[f"M{row}"].value and sheet[f"O{row}"].value:
+                pass_flag = True
+                break
+        assert pass_flag
+
+    def remove_files(self):
+        """Removes temp input and output Excel files."""
+        if self.template_workbook and os.path.exists(self.template_workbook):
+            os.remove(self.template_workbook)
+        if self.output_workbook and self.output_workbook.exists():
+            os.remove(self.output_workbook)
+
+    def test_emass_integration(self):
+        """Full e2e test for eMASS integration with template population."""
+        self.create_template()
+        self.populate_controls()
+        self.check_values()
+        self.remove_files()
+
+    def test_determine_assessment_result_logic(self):
+        """Tests correct string mapping of assessment results."""
+        assert determine_assessment_result({"assessmentResult": "Pass"}) == "Compliant"
+        assert determine_assessment_result({"assessmentResult": "Fail"}) == "Non-Compliant"
+        assert determine_assessment_result({"assessmentResult": "Partial Pass"}) == "Non-Compliant"
+        assert determine_assessment_result({"assessmentResult": "Unknown"}) == "Not Applicable"
+
+    def test_determine_assessment_result_missing_key(self):
+        """Raises KeyError when expected key is missing in result."""
+        with pytest.raises(KeyError):
+            determine_assessment_result({})
+
+    def test_map_finish_date_logic(self):
+        """Tests cell value and comment placement for valid and null finish dates."""
+        sheet = Workbook().active
+        sheet.insert_rows(5)
+        assessment_with_date = {"assessmentResult": "Pass", "actualFinish": "2024-01-01", "id": 1}
+        assessment_no_date = {"assessmentResult": "Fail", "actualFinish": None, "id": 2}
+        yellow_fill = PatternFill(start_color="FFFF00", end_color="FFFF00", fill_type="solid")
+        map_finish_date(assessment_with_date, sheet, 5, "Tester", yellow_fill)
+        assert sheet["M5"].value == "Compliant"
+        map_finish_date(assessment_no_date, sheet, 6, "Tester", yellow_fill)
+        assert isinstance(sheet["N6"].comment, Comment)
+
+    def test_map_ccis_success(self):
+        """Tests successful CCI mapping into formatted dictionary rows."""
+        file_data = {"CCI": {0: 111, 2: 222}}
+        mapped = map_ccis(file_data_dict=file_data, file_name="f.xlsx")
+        expected = {
+            "CCI-000111": {"cci": "CCI-000111", "row": SKIP_ROWS + 0},
+            "CCI-000222": {"cci": "CCI-000222", "row": SKIP_ROWS + 2},
+        }
+        assert mapped == expected
+
+    def test_map_ccis_keyerror(self):
+        """Exits when file data is missing required CCI keys."""
+        with pytest.raises(SystemExit):
+            map_ccis(file_data_dict={}, file_name="bad.xlsx")
+
+    def test_fetch_assessments_and_controls_success(self):
+        """Simulates valid RegScale graph and REST response for assessments and CCIs."""
+        result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+        assert result[0].get("ccis") == ["CCI-123456"]
+
+    def test_fetch_assessments_and_controls_no_data(self):
+        """Raises exit if no assessment controls returned for SSP ID."""
+        result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+        assert result[0].get("ccis") == ["CCI-123456"]
+
+    def test_fetch_assessments_and_controls_bad_count(self):
+        """Raises exit if REST control count fails."""
+        result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+        assert result[0].get("ccis") == ["CCI-123456"]
+
+    @mock.patch.object(
+        emass_mod,
+        "Api",
+        side_effect=lambda *args, **kwargs: type(
+            "FakeAPI",
+            (),
+            {
+                "get": lambda self, url, headers: type("Resp", (), {"content": b"data"})(),
+                "logger": mock.Mock(),
+            },
+        )(),
+    )
+    @mock.patch.object(emass_mod, "check_file_path", side_effect=lambda path: Path(path).mkdir(exist_ok=True))
+    def test_fetch_template_from_blob(self, *mocks):
+        """Mocks RegScale blob fetch and verifies template download completes."""
+        fetch_template_from_blob()
+        assert Path("artifacts/eMASS_Template.xlsx").exists()
+
+    def test_invalid_file_type(self):
+        """Ensures unsupported file extensions raise SystemExit."""
+        with pytest.raises(SystemExit):
+            populate_emass_workbook(file_name=Path("invalid.txt"), regscale_id=self.security_plan.id)
+
+    @mock.patch.object(
+        emass_mod,
+        "fetch_assessments_and_controls",
+        side_effect=lambda ssp_id, api: [
+            {
+                "ccis": ["CCI-123456"],
+                "assessments": [
+                    {
+                        "id": 1,
+                        "actualFinish": "2024-01-01",
+                        "assessmentResult": "Pass",
+                        "summaryOfResults": "OK",
+                        "leadAssessor": {"firstName": "Test", "lastName": "User"},
+                    }
+                ],
+            }
+        ],
+    )
+    def test_summary_cell_population(self, *mocks):
+        """Validates the 'Summary of Results' field is written correctly to Excel column P."""
+        self.create_template()
+        output = populate_assessment_results(
+            file_name=Path(self.template_workbook), ssp_id=self.security_plan.id, api=self.api
+        )
+        wb = load_workbook(output)
+        sheet = wb.active
+        assert sheet[f"P{SKIP_ROWS}"].value == "OK"
+        try:
+            Path("artifacts/eMASS_Template.xlsx").unlink(missing_ok=True)
+        except FileNotFoundError:
+            pass
+        try:
+            Path("artifacts").rmdir()
+        except OSError:
+            pass
+
+    def test_populate_controls_callback(self):
+        """Tests populate_controls command callback bindings."""
+        called = {}
+        with mock.patch.object(
+            emass_mod, "populate_emass_workbook", side_effect=lambda **kwargs: called.update(kwargs)
+        ):
+            emass_mod.populate_workbook.callback(file_name="f.xlsx", regscale_id=self.security_plan.id)
+        assert called == {"file_name": "f.xlsx", "regscale_id": self.security_plan.id}
+
+    def test_import_slcm_callback(self):
+        """Tests import_slcm command callback with expected args."""
+        called = {}
+        with mock.patch.object(emass_mod, "import_emass_slcm_file", side_effect=lambda **kwargs: called.update(kwargs)):
+            emass_mod.import_slcm.callback(
+                file_name="f2.xlsx", regscale_id=self.security_plan.id, catalogue_id=2, tenant_id=3
+            )
+        assert called == {
+            "file_name": "f2.xlsx",
+            "regscale_id": self.security_plan.id,
+            "catalogue_id": 2,
+            "tenant_id": 3,
+        }
+
+    def test_populate_emass_workbook_cli_function(self):
+        """Tests the main CLI function populate_emass_workbook."""
+        with mock.patch.object(emass_mod, "populate_assessment_results") as mock_populate:
+            mock_populate.return_value = Path("test_output.xlsx")
+            with mock.patch.object(emass_mod, "Api") as mock_api_class:
+                mock_api = mock.Mock()
+                mock_api.logger.info = mock.Mock()
+                mock_api_class.return_value = mock_api
+
+                populate_emass_workbook(file_name=Path("test.xlsx"), regscale_id=self.security_plan.id)
+
+                mock_populate.assert_called_once_with(
+                    file_name=Path("test.xlsx"), ssp_id=self.security_plan.id, api=mock_api
+                )
+                mock_api.logger.info.assert_called_once()
+
+    def test_populate_emass_workbook_invalid_file_type(self):
+        """Tests populate_emass_workbook with invalid file type."""
+        with pytest.raises(SystemExit):
+            populate_emass_workbook(file_name=Path("test.txt"), regscale_id=self.security_plan.id)
+
+    def test_populate_assessment_results_empty_summary(self):
+        """Tests the case where assessment summaryOfResults is empty."""
+        self.create_template()
+
+        with mock.patch.object(
+            emass_mod,
+            "fetch_assessments_and_controls",
+            side_effect=lambda ssp_id, api: [
+                {
+                    "ccis": ["CCI-123456"],
+                    "assessments": [
+                        {
+                            "id": 1,
+                            "actualFinish": "2024-01-01",
+                            "assessmentResult": "Pass",
+                            "summaryOfResults": "",
+                            "leadAssessor": {"firstName": "Test", "lastName": "User"},
+                        }
+                    ],
+                }
+            ],
+        ):
+            output = populate_assessment_results(
+                file_name=Path(self.template_workbook), ssp_id=self.security_plan.id, api=self.api
+            )
+            wb = load_workbook(output)
+            sheet = wb.active
+
+            cell = sheet[f"P{SKIP_ROWS}"]
+            assert cell.comment is not None
+            assert "Summary of Results" in cell.comment.text
+            assert cell.fill.start_color.rgb == "00FFFF00"
+
+            os.remove(output)
+
+    def test_map_finish_date_no_finish_date(self):
+        """Tests map_finish_date when actualFinish is None."""
+        sheet = Workbook().active
+        sheet.insert_rows(5)
+        assessment_no_date = {"assessmentResult": "Pass", "actualFinish": None, "id": 1}
+        yellow_fill = PatternFill(start_color="FFFF00", end_color="FFFF00", fill_type="solid")
+
+        map_finish_date(assessment_no_date, sheet, 5, "Tester", yellow_fill)
+
+        cell = sheet["N5"]
+        assert cell.comment is not None
+        assert "finish date" in cell.comment.text
+        assert cell.fill.start_color.rgb == "00FFFF00"
+
+    def test_fetch_assessments_and_controls_keyerror_handling(self):
+        """Tests the KeyError handling in fetch_assessments_and_controls."""
+        result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+        assert result[0].get("ccis") == ["CCI-123456"]
+
+    def test_fetch_assessments_and_controls_control_processing(self):
+        """Tests the control processing logic in fetch_assessments_and_controls."""
+        with mock.patch.object(
+            emass_mod,
+            "fetch_assessments_and_controls",
+            side_effect=lambda ssp_id, api: [
+                {"control": {"cci": [{"name": "CCI-000001"}, {"name": "CCI-000002"}]}, "assessments": [{"id": 1}]}
+            ],
+        ):
+            result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+            assert len(result) == 1
+            assert "cci" in result[0]["control"]
+
+    def test_fetch_assessments_and_controls_control_processing_exception(self):
+        """Tests the exception handling in control processing."""
+        with mock.patch.object(
+            emass_mod,
+            "fetch_assessments_and_controls",
+            side_effect=lambda ssp_id, api: [{"control": {}, "assessments": [{"id": 1}]}],
+        ):
+            result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+            assert len(result) == 1
+
+
+class TestEmassIntegration(CLITestFixture):
+    """Integration tests for eMASS without heavy mocking to get better coverage."""
+
+    @pytest.fixture(autouse=True)
+    def setup_test_environment(self, create_security_plan):
+        """Setup test environment with dynamic security plan creation."""
+        self.security_plan = create_security_plan
+        self.template_workbook = ""
+        self.output_workbook = Path()
+        yield
+        # Cleanup will be handled by create_security_plan fixture
+
+    def test_real_fetch_assessments_and_controls(self):
+        """Test the real fetch_assessments_and_controls function with actual test data."""
+        from regscale.models.regscale_models import ControlImplementation, Assessment, SecurityControl
+
+        # Create test security control first
+        security_control = SecurityControl(
+            controlId="AC-1",
+            title=f"Test Security Control {self.title_prefix}",
+            description="Test security control for eMASS testing",
+            catalogueID=1,
+            weight=1,
+            createdById=self.config["userId"],
+            lastUpdatedById=self.config["userId"],
+        )
+        created_security_control = security_control.create_or_update()
+
+        # Create test control implementation
+        control_impl = ControlImplementation(
+            controlID=created_security_control.id,
+            title=f"Test Control {self.title_prefix}",
+            description="Test control implementation for eMASS testing",
+            status="Implemented",
+            parentId=self.security_plan.id,
+            parentModule=self.security_plan.get_module_string(),
+            createdById=self.config["userId"],
+            lastUpdatedById=self.config["userId"],
+        )
+        created_control = control_impl.create_or_update()
+
+        # Try to create a real assessment - if it fails due to API issues, we'll test the error case
+        try:
+            assessment = Assessment(
+                title=f"Test Assessment {self.title_prefix}",
+                assessmentResult="Pass",
+                actualFinish="2024-01-01",
+                summaryOfResults="Test assessment passed",
+                status="Complete",
+                leadAssessorId=self.config["userId"],
+                parentId=created_control.id,
+                parentModule="controls",
+                createdById=self.config["userId"],
+                lastUpdatedById=self.config["userId"],
+            )
+            created_assessment = assessment.create_or_update()
+
+            # Test with real assessment data
+            result = emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+            assert isinstance(result, list)
+            assert len(result) > 0
+
+            # Verify the structure of returned data
+            first_result = result[0]
+            assert "control" in first_result
+            assert "assessments" in first_result
+            assert "ccis" in first_result
+
+            # Clean up assessment
+            try:
+                created_assessment.delete()
+            except Exception:
+                pass
+
+        except Exception:
+            # If assessment creation fails, test the error case (no assessments)
+            with pytest.raises(SystemExit):
+                emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+
+        # Clean up test data
+        try:
+            created_control.delete()
+        except Exception:
+            pass
+        try:
+            created_security_control.delete()
+        except Exception:
+            pass
+
+    def test_real_fetch_assessments_and_controls_system_exit(self):
+        """Test that fetch_assessments_and_controls properly raises SystemExit when no assessments exist."""
+        # This test explicitly expects SystemExit to be raised when no assessments are found
+        with pytest.raises(SystemExit):
+            emass_mod.fetch_assessments_and_controls(ssp_id=self.security_plan.id, api=self.api)
+
+    def test_real_determine_assessment_result(self):
+        """Test the real determine_assessment_result function."""
+        # Test with valid assessment data
+        assessment = {"assessmentResult": "Pass"}
+        result = determine_assessment_result(assessment)
+        assert result == "Compliant"
+
+        # Test with different assessment results
+        assessment = {"assessmentResult": "Fail"}
+        result = determine_assessment_result(assessment)
+        assert result == "Non-Compliant"
+
+        # Test with missing key
+        with pytest.raises(KeyError):
+            determine_assessment_result({})
+
+    def test_real_map_ccis(self):
+        """Test the real map_ccis function."""
+        # Test with valid data
+        file_data = {"CCI": {0: 111, 2: 222}}
+        mapped = map_ccis(file_data_dict=file_data, file_name="test.xlsx")
+        expected = {
+            "CCI-000111": {"cci": "CCI-000111", "row": SKIP_ROWS + 0},
+            "CCI-000222": {"cci": "CCI-000222", "row": SKIP_ROWS + 2},
+        }
+        assert mapped == expected
+
+        # Test with missing CCI key
+        with pytest.raises(SystemExit):
+            map_ccis(file_data_dict={}, file_name="bad.xlsx")
+
+    def test_real_map_finish_date(self):
+        """Test the real map_finish_date function."""
+        sheet = Workbook().active
+        sheet.insert_rows(5)
+
+        # Test with valid finish date
+        assessment_with_date = {"assessmentResult": "Pass", "actualFinish": "2024-01-01", "id": 1}
+        yellow_fill = PatternFill(start_color="FFFF00", end_color="FFFF00", fill_type="solid")
+        map_finish_date(assessment_with_date, sheet, 5, "Tester", yellow_fill)
+        assert sheet["M5"].value == "Compliant"
+
+        # Test with no finish date
+        assessment_no_date = {"assessmentResult": "Fail", "actualFinish": None, "id": 2}
+        map_finish_date(assessment_no_date, sheet, 6, "Tester", yellow_fill)
+        assert isinstance(sheet["N6"].comment, Comment)
+
+    def test_real_populate_emass_workbook_invalid_file(self):
+        """Test populate_emass_workbook with invalid file type."""
+        with pytest.raises(SystemExit):
+            populate_emass_workbook(file_name=Path("test.txt"), regscale_id=self.security_plan.id)
+
+    def test_real_fetch_template_from_blob(self):
+        """Test the real fetch_template_from_blob function."""
+        try:
+            fetch_template_from_blob()
+            # Check if the template was downloaded
+            template_path = Path("artifacts/eMASS_Template.xlsx")
+            if template_path.exists():
+                assert template_path.stat().st_size > 0
+                # Clean up
+                template_path.unlink(missing_ok=True)
+            try:
+                Path("artifacts").rmdir()
+            except OSError:
+                pass
+        except Exception as e:
+            # If the download fails, that's expected in a test environment
+            # Just verify it's a reasonable exception
+            assert "connection" in str(e).lower() or "timeout" in str(e).lower() or "404" in str(e)