Merge pull request #2456 from strictdoc-project/stanislaw/html2pdf_update

feat(HTML2PDF): integrate --strict mode, split normal tests and HTML2PDF tests

Author: stanislaw

.github/workflows/ci-linux-ubuntu-latest.yml

@@ -15,6 +15,7 @@ jobs:
         python-version: [
           "3.9", "3.12"
         ]
+        itest_group: [ "main_group", "html2pdf_group" ]
 
     steps:
     - uses: actions/checkout@v3
@@ -38,4 +39,8 @@ jobs:
 
     - name: Run tests
       run: |
-        invoke test
+        if [ "${{ matrix.itest_group }}" = "html2pdf_group" ]; then
+          invoke test-integration --html2pdf
+        else
+          invoke test
+        fi

.github/workflows/ci-mac.yml

@@ -15,6 +15,7 @@ jobs:
         python-version: [
           "3.9", "3.13"
         ]
+        itest_group: [ "main_group", "html2pdf_group" ]
 
     steps:
     - uses: actions/checkout@v3
@@ -38,4 +39,8 @@ jobs:
 
     - name: Run tests
       run: |
-        invoke test
+        if [ "${{ matrix.itest_group }}" = "html2pdf_group" ]; then
+          invoke test-integration --html2pdf
+        else
+          invoke test
+        fi

.github/workflows/ci-windows-powershell.yml

@@ -14,6 +14,7 @@ jobs:
       matrix:
         python-version: ["3.9"]
         shard: ["1/2", "2/2"]
+        itest_group: [ "main_group", "html2pdf_group" ]
 
     steps:
     - uses: actions/checkout@v3
@@ -52,6 +53,11 @@ jobs:
         $tidyPath = (Get-ChildItem "C:\ProgramData\chocolatey\lib\html-tidy" -Recurse -Filter tidy.exe | Select-Object -First 1).DirectoryName
         echo "$tidyPath" | Out-File -Append -Encoding ascii $env:GITHUB_PATH
 
-    - name: Run tests (Powershell)
+    - name: Run tests
+      shell: bash
       run: |
-        invoke test --shard=${{ matrix.shard }}
+        if [ "${{ matrix.itest_group }}" = "html2pdf_group" ]; then
+          invoke test-integration --html2pdf --shard=${{ matrix.shard }}
+        else
+          invoke test --shard=${{ matrix.shard }}
+        fi

.github/workflows/ci-windows.yml

@@ -14,6 +14,7 @@ jobs:
       matrix:
         python-version: ["3.12"]
         shard: ["1/2", "2/2"]
+        itest_group: [ "main_group", "html2pdf_group" ]
 
     steps:
     - uses: actions/checkout@v3
@@ -56,7 +57,11 @@ jobs:
       run: |
         invoke lint
 
-    - name: Run tests (Bash)
-      run: |
-        invoke test --shard=${{ matrix.shard }}
+    - name: Run tests
       shell: bash
+      run: |
+        if [ "${{ matrix.itest_group }}" = "html2pdf_group" ]; then
+          invoke test-integration --html2pdf --shard=${{ matrix.shard }}
+        else
+          invoke test --shard=${{ matrix.shard }}
+        fi

pyproject.toml

@@ -91,7 +91,7 @@ dependencies = [
     "WebSockets",
 
     # HTML2PDF dependencies
-    "html2pdf4doc >= 0.0.21",
+    "html2pdf4doc >= 0.0.22",
 
     # Robot Framework dependencies
     "robotframework >= 4.0.0",

strictdoc.toml

@@ -28,8 +28,6 @@ features = [
   "NESTOR",
 ]
 
-statistics_generator = "docs.sdoc_project_statistics.SDocStatisticsGenerator"
-
 include_doc_paths = [
   "docs/**",
   "docs_extra/**",
@@ -66,3 +64,7 @@ test_report_root_dict = [
   { "reports/tests_integration.lit.junit.xml" = "tests/integration" },
   { "reports/tests_integration_html2pdf.lit.junit.xml" = "tests/integration" },
 ]
+
+html2pdf_strict = false
+
+statistics_generator = "docs.sdoc_project_statistics.SDocStatisticsGenerator"

strictdoc/core/project_config.py

@@ -97,6 +97,7 @@ def __init__(
         exclude_source_paths: List[str],
         test_report_root_dict: Dict[str, str],
         source_nodes: List[Dict[str, str]],
+        html2pdf_strict: bool,
         html2pdf_template: Optional[str],
         bundle_document_version: Optional[str],
         bundle_document_date: Optional[str],
@@ -172,6 +173,7 @@ def __init__(
 
         self.excel_export_fields: Optional[List[str]] = None
 
+        self.html2pdf_strict: bool = html2pdf_strict
         self.html2pdf_template: Optional[str] = html2pdf_template
         self.bundle_document_version: Optional[str] = bundle_document_version
         self.bundle_document_date: Optional[str] = bundle_document_date
@@ -226,6 +228,7 @@ def default_config(environment: SDocRuntimeEnvironment) -> "ProjectConfig":
             exclude_source_paths=[],
             test_report_root_dict={},
             source_nodes=[],
+            html2pdf_strict=False,
             html2pdf_template=None,
             bundle_document_version=ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_VERSION,
             bundle_document_date=ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_COMMIT_DATE,
@@ -505,6 +508,7 @@ def _load_from_dictionary(
         exclude_source_paths: List[str] = []
         test_report_root_dict: Dict[str, str] = {}
         source_nodes: List[Dict[str, str]] = []
+        html2pdf_strict: bool = False
         html2pdf_template: Optional[str] = None
         bundle_document_version = ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_VERSION
         bundle_document_date = ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_COMMIT_DATE
@@ -626,6 +630,16 @@ def _load_from_dictionary(
                         f"{exception_} Provided string: '{exclude_source_path}'."
                     ) from exception_
 
+            html2pdf_strict = project_content.get(
+                "html2pdf_strict", html2pdf_strict
+            )
+            if html2pdf_strict is not None:
+                if not isinstance(html2pdf_strict, bool):
+                    raise ValueError(
+                        "strictdoc.toml: 'html2pdf_strict': "
+                        f"must be a true/false value: {html2pdf_strict}."
+                    )
+
             html2pdf_template = project_content.get(
                 "html2pdf_template", html2pdf_template
             )
@@ -757,6 +771,7 @@ def _load_from_dictionary(
             exclude_source_paths=exclude_source_paths,
             test_report_root_dict=test_report_root_dict,
             source_nodes=source_nodes,
+            html2pdf_strict=html2pdf_strict,
             html2pdf_template=html2pdf_template,
             bundle_document_version=bundle_document_version,
             bundle_document_date=bundle_document_date,

strictdoc/export/html2pdf/pdf_print_driver.py

@@ -39,6 +39,8 @@ def get_pdf_from_html(
                     project_config.chromedriver,
                 ]
             )
+        if project_config.html2pdf_strict:
+            cmd.append("--strict")
         for path_to_print_ in paths_to_print:
             cmd.append(path_to_print_[0])
             cmd.append(path_to_print_[1])

tasks.py

@@ -686,7 +686,6 @@ def test(context, shard=None):
     test_unit(context)
     test_unit_server(context)
     test_integration(context, shard=shard)
-    test_integration(context, shard=shard, html2pdf=True)
 
 
 @task(aliases=["ta"])

tests/integration/features/html2pdf/90_strictdoc_smoke_test_html2pdf/test.itest

@@ -0,0 +1,5 @@
+REQUIRES: PYTHON_39_OR_HIGHER
+REQUIRES: PLATFORM_IS_NOT_WINDOWS
+REQUIRES: TEST_HTML2PDF
+
+RUN: cd "%strictdoc_root/" && %strictdoc export "%strictdoc_root/" --formats=html2pdf --output-dir="%T"