implement PP tests

4 files changed, 202 insertions, 8 deletions

diff --git a/tests/cc/conftest.py b/tests/cc/conftest.py
index 6ddb74a2..91f8caab 100644
--- a/tests/cc/conftest.py
+++ b/tests/cc/conftest.py
@@ -4,18 +4,33 @@ from importlib import resources
 from pathlib import Path
 
 import pytest
+import tests.data.cc.analysis
 import tests.data.cc.dataset
+import tests.data.protection_profiles
 
 from sec_certs.dataset.cc import CCDataset
+from sec_certs.dataset.protection_profile import ProtectionProfileDataset
 from sec_certs.sample.cc import CCCertificate
 
 
 @pytest.fixture(scope="module")
+def pp_data_dir() -> Generator[Path, None, None]:
+    with resources.path(tests.data.protection_profiles, "") as path:
+        yield path
+
+
+@pytest.fixture(scope="module")
 def data_dir() -> Generator[Path, None, None]:
     with resources.path(tests.data.cc.dataset, "") as path:
         yield path
 
 
+@pytest.fixture(scope="module")
+def analysis_data_dir() -> Generator[Path, None, None]:
+    with resources.path(tests.data.cc.analysis, "") as path:
+        yield path
+
+
 @pytest.fixture
 def toy_dataset() -> CCDataset:
     with resources.path(tests.data.cc.dataset, "toy_dataset.json") as path:
@@ -23,6 +38,12 @@ def toy_dataset() -> CCDataset:
 
 
 @pytest.fixture
+def toy_pp_dataset() -> ProtectionProfileDataset:
+    with resources.path(tests.data.protection_profiles, "pp.json") as path:
+        return ProtectionProfileDataset.from_json(path)
+
+
+@pytest.fixture
 def cert_one() -> CCCertificate:
     return CCCertificate(
         "active",
diff --git a/tests/cc/test_cc_analysis.py b/tests/cc/test_cc_analysis.py
index 849eda68..6591ca18 100644
--- a/tests/cc/test_cc_analysis.py
+++ b/tests/cc/test_cc_analysis.py
@@ -33,10 +33,11 @@ def analysis_data_dir() -> Generator[Path, None, None]:
 
 @pytest.fixture(scope="module")
 def processed_cc_dset(
-    analysis_data_dir: Path, cve_dataset: CVEDataset, cpe_dataset: CPEDataset, tmp_path_factory
+    analysis_data_dir: Path, cve_dataset: CVEDataset, cpe_dataset: CPEDataset, tmp_path_factory, pp_data_dir: Path
 ) -> CCDataset:
     tmp_dir = tmp_path_factory.mktemp("cc_dset")
     shutil.copytree(analysis_data_dir, tmp_dir, dirs_exist_ok=True)
+    shutil.copy(pp_data_dir / "pp.json", tmp_dir / "pp.json")
 
     cc_dset = CCDataset.from_json(tmp_dir / "vulnerable_dataset.json")
     cc_dset.aux_handlers[ProtectionProfileDatasetHandler].root_dir.mkdir(parents=True, exist_ok=True)
diff --git a/tests/cc/test_cc_dataset.py b/tests/cc/test_cc_dataset.py
index 7606a921..4c988b5b 100644
--- a/tests/cc/test_cc_dataset.py
+++ b/tests/cc/test_cc_dataset.py
@@ -6,6 +6,7 @@ from tempfile import TemporaryDirectory
 import pytest
 
 from sec_certs import constants
+from sec_certs.dataset import ProtectionProfileDataset
 from sec_certs.dataset.cc import CCDataset
 from sec_certs.sample.cc import CCCertificate
 
@@ -106,6 +107,7 @@ def test_build_empty_dataset():
         dset.get_certs_from_web(to_download=False, get_archived=False, get_active=False)
     assert len(dset) == 0
     assert dset.state.meta_sources_parsed
+    assert not dset.state.auxiliary_datasets_processed
     assert not dset.state.artifacts_downloaded
     assert not dset.state.pdfs_converted
     assert not dset.state.certs_analyzed
@@ -130,17 +132,22 @@ def test_build_dataset(data_dir: Path, cert_one: CCCertificate, toy_dataset: CCD
 
 
 @pytest.mark.xfail(reason="May fail due to error on CC server")
-def test_download_csv_html_files():
+@pytest.mark.parametrize("dataset_class", ["CCDataset", "ProtectionProfileDataset"])
+def test_download_csv_html_files(dataset_class):
     with TemporaryDirectory() as tmp_dir:
-        dset = CCDataset({}, Path(tmp_dir), "sample_dataset", "sample dataset description")
-        dset._download_csv_html_resources(get_active=True, get_archived=False)
+        constructor = CCDataset if dataset_class == "CCDataset" else ProtectionProfileDataset
+        min_html_size = constants.MIN_CC_HTML_SIZE if dataset_class == "CCDataset" else constants.MIN_PP_HTML_SIZE
+        dset = constructor(root_dir=Path(tmp_dir))
+        dset._download_html_resources(get_active=True, get_archived=False)
 
         for x in dset.active_html_tuples:
             assert x[1].exists()
-            assert x[1].stat().st_size >= constants.MIN_CC_HTML_SIZE
-        for x in dset.active_csv_tuples:
-            assert x[1].exists()
-            assert x[1].stat().st_size >= constants.MIN_CC_CSV_SIZE
+            assert x[1].stat().st_size >= min_html_size
+
+        if dataset_class == "CCDataset":
+            for x in dset.active_csv_tuples:
+                assert x[1].exists()
+                assert x[1].stat().st_size >= constants.MIN_CC_CSV_SIZE
 
 
 def test_to_pandas(toy_dataset: CCDataset):
diff --git a/tests/cc/test_cc_protection_profiles.py b/tests/cc/test_cc_protection_profiles.py
new file mode 100644
index 00000000..9bb47564
--- /dev/null
+++ b/tests/cc/test_cc_protection_profiles.py
@@ -0,0 +1,165 @@
+import json
+import shutil
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+import pytest
+
+from sec_certs.dataset.protection_profile import ProtectionProfileDataset
+
+
+def test_dataset_from_json(toy_pp_dataset: ProtectionProfileDataset, pp_data_dir: Path, tmp_path: Path):
+    toy_pp_dataset.to_json(tmp_path / "dset.json")
+    with (tmp_path / "dset.json").open("r") as handle:
+        data = json.load(handle)
+
+    with (pp_data_dir / "pp.json").open("r") as handle:
+        template_data = json.load(handle)
+
+    del data["timestamp"]
+    del template_data["timestamp"]
+    assert data == template_data
+
+
+def test_dataset_to_json(toy_pp_dataset: ProtectionProfileDataset, pp_data_dir: Path, tmp_path: Path):
+    assert toy_pp_dataset == ProtectionProfileDataset.from_json(pp_data_dir / "pp.json")
+    compressed_path = tmp_path / "dset.json.gz"
+    toy_pp_dataset.to_json(compressed_path, compress=True)
+    decompressed_dataset = ProtectionProfileDataset.from_json(compressed_path, is_compressed=True)
+    assert toy_pp_dataset == decompressed_dataset
+
+
+def test_build_empty_dataset():
+    with TemporaryDirectory() as tmp_dir:
+        dset = ProtectionProfileDataset(root_dir=Path(tmp_dir))
+        dset.get_certs_from_web(to_download=False, get_archived=False, get_active=False, get_collaborative=False)
+
+    assert len(dset) == 0
+    assert dset.state.meta_sources_parsed
+    assert not dset.state.auxiliary_datasets_processed
+    assert not dset.state.artifacts_downloaded
+    assert not dset.state.pdfs_converted
+    assert not dset.state.certs_analyzed
+
+
+def test_get_certs_from_web(pp_data_dir: Path, toy_pp_dataset: ProtectionProfileDataset):
+    with TemporaryDirectory() as tmp_dir:
+        dataset_path = Path(tmp_dir)
+        (dataset_path / "web").mkdir()
+        shutil.copyfile(pp_data_dir / "pp_active.html", dataset_path / "web/pp_active.html")
+
+        dset = ProtectionProfileDataset(root_dir=dataset_path)
+        dset.get_certs_from_web(
+            to_download=False,
+            get_active=True,
+            get_archived=False,
+            get_collaborative=False,
+            keep_metadata=False,
+            update_json=False,
+        )
+
+        assert len(list(dataset_path.iterdir())) == 0
+        assert len(dset) == 3
+        assert "b02ed76d2545326a" in dset.certs
+        assert dset == toy_pp_dataset
+
+
+def test_download_and_convert_artifacts(toy_pp_dataset: ProtectionProfileDataset, tmpdir, pp_data_dir):
+    toy_pp_dataset.copy_dataset(tmpdir)
+    toy_pp_dataset.download_all_artifacts()
+
+    template_pp_pdf_hashes = {
+        "c8b175590bb7fdfb": "f35ea732cfe303415080e0a95b9aa573ff9e02019e9ab971904c7530c2617b80",
+        "e315e3e834a61448": "605489cda568c32371d0aeb6841df0dc63277f57113f59a5a60f8a64a1661def",
+        "b02ed76d2545326a": "e88bddd8948a8624d3f350e4cb489f4b1b708e5f10e2c1402166cdfe08e5d32a",
+    }
+    template_report_pdf_hashes = {
+        "c8b175590bb7fdfb": "c7dbaec8c333431c65129a0f429cdea22aa244e971f79139fb0ae079d4805b29",
+        "e315e3e834a61448": "5f72a3ef0dce80b66c077a8a7482a1843c36e90113bd77827fba81c6e148d248",
+        "b02ed76d2545326a": "e4c2d590fce870cd14fe6571a3258bd094b1e66f83f5e4d4a53a28a96f27490e",
+    }
+
+    if not all(
+        [
+            toy_pp_dataset["c8b175590bb7fdfb"].state.pp.download_ok,
+            toy_pp_dataset["c8b175590bb7fdfb"].state.report.download_ok,
+            toy_pp_dataset["e315e3e834a61448"].state.pp.download_ok,
+            toy_pp_dataset["e315e3e834a61448"].state.report.download_ok,
+            toy_pp_dataset["b02ed76d2545326a"].state.pp.download_ok,
+            toy_pp_dataset["b02ed76d2545326a"].state.report.download_ok,
+        ]
+    ):
+        pytest.xfail(reason="Fail due to errror during download")
+
+    toy_pp_dataset.convert_all_pdfs()
+
+    for cert in toy_pp_dataset:
+        assert cert.state.pp.pdf_hash == template_pp_pdf_hashes[cert.dgst]
+        assert cert.state.report.pdf_hash == template_report_pdf_hashes[cert.dgst]
+        assert cert.state.report.convert_ok
+        assert cert.state.pp.convert_ok
+        assert cert.state.report.txt_path.exists()
+        assert cert.state.pp.txt_path.exists()
+
+    template_report_txt_path = pp_data_dir / "reports/txt/b02ed76d2545326a.txt"
+    template_pp_txt_path = pp_data_dir / "pps/txt/b02ed76d2545326a.txt"
+    assert (
+        abs(
+            toy_pp_dataset["b02ed76d2545326a"].state.report.txt_path.stat().st_size
+            - template_report_txt_path.stat().st_size
+        )
+        < 1000
+    )
+    assert (
+        abs(toy_pp_dataset["b02ed76d2545326a"].state.pp.txt_path.stat().st_size - template_pp_txt_path.stat().st_size)
+        < 1000
+    )
+
+
+def test_keyword_extraction(toy_pp_dataset: ProtectionProfileDataset, pp_data_dir: Path, tmpdir):
+    toy_pp_dataset.state.artifacts_downloaded = True
+    toy_pp_dataset.state.pdfs_converted = True
+    toy_pp_dataset.state.auxiliary_datasets_processed = True
+
+    toy_pp_dataset.copy_dataset(tmpdir)
+
+    toy_pp_dataset["b02ed76d2545326a"].state.pp.download_ok = True
+    toy_pp_dataset["b02ed76d2545326a"].state.pp.convert_ok = True
+    toy_pp_dataset["b02ed76d2545326a"].state.report.download_ok = True
+    toy_pp_dataset["b02ed76d2545326a"].state.report.convert_ok = True
+
+    toy_pp_dataset.analyze_certificates()
+    assert toy_pp_dataset.state.certs_analyzed
+    assert not toy_pp_dataset["c8b175590bb7fdfb"].state.pp.extract_ok
+    assert not toy_pp_dataset["e315e3e834a61448"].state.report.extract_ok
+
+    report_keywords = toy_pp_dataset["b02ed76d2545326a"].pdf_data.report_keywords
+    assert report_keywords
+    assert "cc_protection_profile_id" in report_keywords
+    assert report_keywords["cc_protection_profile_id"]["BSI"]["BSI-CC-PP-0062-2010"] == 14
+
+    pp_keywords = toy_pp_dataset["b02ed76d2545326a"].pdf_data.pp_keywords
+    assert pp_keywords
+    assert "cc_security_level" in pp_keywords
+    assert pp_keywords["cc_security_level"]["EAL"]["EAL 2"] == 6
+    assert "tee_name" in pp_keywords
+    assert pp_keywords["tee_name"]["IBM"]["SE"] == 1
+    assert not pp_keywords["asymmetric_crypto"]
+
+    pp_metadata = toy_pp_dataset["b02ed76d2545326a"].pdf_data.pp_metadata
+    assert pp_metadata
+    assert not pp_metadata["pdf_is_encrypted"]
+    assert "https://www.bsi.bund.de" in pp_metadata["pdf_hyperlinks"]
+
+    report_metadata = toy_pp_dataset["b02ed76d2545326a"].pdf_data.report_metadata
+    assert report_metadata
+    assert "BSI-CC-PP-0062-2010" in report_metadata["/Title"]
+
+
+def test_get_pp_by_pp_link(toy_pp_dataset: ProtectionProfileDataset):
+    pp = toy_pp_dataset.get_pp_by_pp_link(
+        "https://www.commoncriteriaportal.org/nfs/ccpfiles/files/ppfiles/pp0062b_pdf.pdf"
+    )
+    assert pp
+    assert pp.dgst == "b02ed76d2545326a"
+    assert not toy_pp_dataset.get_pp_by_pp_link("https://some-random-url.com")