[
{
"path": ".dockerignore",
"content": "*\n!build/install\n"
},
{
"path": ".editorconfig",
"content": "# EditorConfig is awesome:\n# - https://EditorConfig.org\n# - https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties\n# - https://blog.logrocket.com/using-prettier-eslint-automate-formatting-fixing-javascript/\n# - https://prettier.io/docs/en/options.html\n\n# top-most EditorConfig file\nroot = true\n\n[*]\ncharset = utf-8\n# end_of_line = lf | crlf\n# indent_size = 2\n# indent_style = tab\ninsert_final_newline = true\n# supported in only some editors; instead use prettier.printWidth\nmax_line_length = 120\ntrim_trailing_whitespace = true\n\n[*.{markdown,md,mdx}]\nindent_style = space\ntrim_trailing_whitespace = false\n\n\n[*.{json,yaml,yml,toml}]\n# indent_size = 2\nindent_style = space\n\n[Dockerfile]\n# indent_size = 4\nindent_style = space\n\n[*.{kt,kts}]\nmax_line_length = 160\nij_kotlin_allow_trailing_comma_on_call_site = false\nij_kotlin_allow_trailing_comma = false\n\nktlint_standard_no-wildcard-imports = disabled\nktlint_standard_argument-list-wrapping = disabled\nktlint_standard_if-else-wrapping = disabled\nktlint_standard_if-else-bracing = disabled\nktlint_standard_multiline-if-else = disabled\nktlint_standard_function-signature = disabled\nktlint_standard_blank-line-before-declaration = disabled\nktlint_standard_multiline-expression-wrapping = disabled\nktlint_standard_string-template-indent = disabled\n"
},
{
"path": ".gitattributes",
"content": "#\n# https://help.github.com/articles/dealing-with-line-endings/\n#\n# These are explicitly windows files and should use crlf\n*.bat text eol=crlf\n\n"
},
{
"path": ".github/workflows/pr.yml",
"content": "name: pr\non:\n pull_request:\n branches:\n - main\n push:\n branches:\n - main\n\nenv:\n IMAGE_NAME: ${{ github.event.repository.name }}\n VERSION: '0.0.1'\n\njobs:\n build-gradle:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-java@v5\n with:\n distribution: temurin\n java-version: 21\n - name: Setup Gradle\n uses: gradle/gradle-build-action@v3.5.0\n - name: Ensure browsers are installed\n run: ./gradlew playwright -Pargs=\"install --with-deps\"\n - name: Execute Gradle build\n run: ./gradlew test installDist\n - name: Archive production artifacts\n uses: actions/upload-artifact@v7\n with:\n name: binaries\n path: build/install\n retention-days: 1\n build-docker:\n runs-on: ubuntu-latest\n needs: build-gradle\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n - name: Set up Docker Buildx\n id: buildx\n uses: docker/setup-buildx-action@v4\n\n - name: Download binaries\n uses: actions/download-artifact@v8\n with:\n name: binaries\n path: build/install\n\n - name: Build container image\n uses: docker/build-push-action@v7\n with:\n push: false\n builder: ${{ steps.buildx.outputs.name }}\n context: .\n file: ./Dockerfile\n platforms: linux/amd64,linux/arm64/v8\n tags: |\n ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:${{ env.VERSION }}\n ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:latest\n labels: |\n org.opencontainers.image.title=${{ github.event.repository.name }}\n org.opencontainers.image.description=${{ github.event.repository.description }}\n org.opencontainers.image.url=${{ github.event.repository.html_url }}\n org.opencontainers.image.revision=${{ github.sha }}\n org.opencontainers.image.version=${{ env.VERSION }}\n"
},
{
"path": ".github/workflows/release.yml",
"content": "name: release\non:\n push:\n tags:\n - '*'\n\nenv:\n IMAGE_NAME: ${{ github.event.repository.name }}\n\njobs:\n build-gradle:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-java@v5\n with:\n distribution: temurin\n java-version: 21\n - name: Setup Gradle\n uses: gradle/gradle-build-action@v3.5.0\n - name: Ensure browsers are installed\n run: ./gradlew playwright -Pargs=\"install --with-deps\"\n - name: Execute Gradle build\n run: ./gradlew -PprojectVersion=${{ github.ref_name }} test assemble installDist\n - name: Archive binaries\n uses: actions/upload-artifact@v7\n with:\n name: binaries\n path: build/install\n retention-days: 1\n - name: Archive distribution\n uses: actions/upload-artifact@v7\n with:\n name: distribution\n path: build/distributions\n retention-days: 1\n build-push-docker:\n runs-on: ubuntu-latest\n needs: build-gradle\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@v4\n with:\n registry: ghcr.io\n username: ${{ github.actor }}\n password: ${{ secrets.GITHUB_TOKEN }}\n - name: Set up Docker Buildx\n id: buildx\n uses: docker/setup-buildx-action@v4\n - name: Set up cosign\n uses: sigstore/cosign-installer@main\n\n - name: Download binaries\n uses: actions/download-artifact@v8\n with:\n name: binaries\n path: build/install\n - name: Download distribution\n uses: actions/download-artifact@v8\n with:\n name: distribution\n path: build/distributions\n\n - name: Build and publish container image\n uses: docker/build-push-action@v7\n id: build_push\n with:\n push: true\n builder: ${{ steps.buildx.outputs.name }}\n context: .\n file: ./Dockerfile\n platforms: linux/amd64,linux/arm64/v8\n tags: |\n ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:${{ github.ref_name }}\n ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:latest\n labels: |\n org.opencontainers.image.title=${{ github.event.repository.name }}\n org.opencontainers.image.description=${{ github.event.repository.description }}\n org.opencontainers.image.url=${{ github.event.repository.html_url }}\n org.opencontainers.image.source=${{ github.event.repository.html_url }}\n org.opencontainers.image.revision=${{ github.sha }}\n org.opencontainers.image.version=${{ github.ref_name }}\n - name: sign container image\n run: |\n cosign sign --yes --key env://COSIGN_KEY ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:${{ github.ref_name }}@${{ steps.build_push.outputs.digest }}\n shell: bash\n env:\n COSIGN_KEY: ${{secrets.COSIGN_KEY}}\n COSIGN_PASSWORD: ${{secrets.COSIGN_PASSWORD}}\n\n - name: Check images\n run: |\n docker buildx imagetools inspect ghcr.io/avisi-cloud/${IMAGE_NAME}:${{ github.ref_name }}\n docker pull ghcr.io/avisi-cloud/${IMAGE_NAME}:${{ github.ref_name }}\n cosign verify --key cosign.pub ghcr.io/avisi-cloud/${IMAGE_NAME}:${{ github.ref_name }}\n - uses: anchore/sbom-action@v0\n with:\n image: ghcr.io/avisi-cloud/${{ env.IMAGE_NAME }}:${{ github.ref_name }}\n\n create-draft-release:\n runs-on: ubuntu-latest\n needs: build-gradle\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n\n - name: Download distribution\n uses: actions/download-artifact@v8\n with:\n name: distribution\n path: build/distributions\n\n - name: Create Release Draft\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n gh release create ${{ github.ref_name }} \\\n --draft \\\n --title \"${{ github.ref_name }}\"\n - name: Upload Release Assets\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: gh release upload ${{ github.ref_name }} ./build/distributions/*\n\n generate-example-site:\n runs-on: ubuntu-latest\n needs: build-gradle\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n - uses: actions/setup-java@v5\n with:\n distribution: temurin\n java-version: 21\n\n - name: Download binaries\n uses: actions/download-artifact@v8\n with:\n name: binaries\n path: build/install\n\n - name: Set up environment\n run: |\n sudo apt-get install -y graphviz\n chmod +x build/install/structurizr-site-generatr/bin/structurizr-site-generatr\n\n - name: Generate example site\n run: >\n build/install/structurizr-site-generatr/bin/structurizr-site-generatr generate-site\n --git-url https://github.com/avisi-cloud/structurizr-site-generatr.git\n --workspace-file docs/example/workspace.dsl\n --assets-dir docs/example/assets\n --branches main\n --default-branch main\n --version ${{ github.ref_name }}\n\n - name: Upload example site as GitHub Pages artifact\n uses: actions/upload-pages-artifact@v5\n with:\n path: ./build/site\n\n publish-example-site:\n runs-on: ubuntu-latest\n needs: generate-example-site\n\n permissions:\n pages: write\n id-token: write\n\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n\n steps:\n - name: Deploy example site to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v5\n"
},
{
"path": ".gitignore",
"content": ".gradle\n.idea\nbuild\nout\n*.md_\n.vscode\nbin\n"
},
{
"path": ".markdownlint.json",
"content": "{\n \"default\": true,\n \"MD013\": false,\n \"MD041\": false\n}"
},
{
"path": ".prettierrc",
"content": "{ \"printWidth\": 120 }\n"
},
{
"path": ".run/all unit tests.run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n \n"
},
{
"path": ".run/generate site for example model (from git repo all branches) .run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n"
},
{
"path": ".run/generate site for example model (from git repo).run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n"
},
{
"path": ".run/generate site for example model (local).run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n"
},
{
"path": ".run/serve example model.run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n"
},
{
"path": ".tool-versions",
"content": "java temurin-21.0.10+7.0.LTS\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# How to contribute\n\nWe welcome contributions! You can contribute\nby [filing an issue](https://github.com/avisi-cloud/structurizr-site-generatr/issues), or by filing a pull request.\n\nFor those who'd like to help out by filing a pull request, here's some information to help you get started quickly.\n\n## Recommended development tooling\n\nWe recommend using IntelliJ Community or Ultimate edition as your IDE. Additionally, you will need the following tools:\n\n- Git for version control\n- Java Development Kit (JDK) version 18 for building the source code\n- (optional) [asdf-vm](https://asdf-vm.com/). We have provided a `.tool-versions` file in this repository, which is used\n by `asdf` to help you to install the correct JDK version for building this tool.\n\n## Working from the command line\n\nIf you prefer working with a terminal, here's a few commands you can use for some common tasks. For all these commands,\nwe assume that the current working directory is the root of this repository. For all these common tasks, we use the\nGradle CLI. Please refer to Gradle's [user manual](https://docs.gradle.org/current/userguide/userguide.html) if you're\nnot familiar with Gradle.\n\n### Running tests\n\n```shell\n./gradlew test\n```\n\n### Running the application from source\n\n```shell\n./gradlew run --args \"\"\n```\n\n#### Example: Start a development server from source\n\n```shell\n./gradlew run --args \"serve --workspace-file docs/example/workspace.dsl --assets-dir docs/example/assets\"\n```\n\n## Working with IntelliJ\n\nFor those working with IntelliJ, we've provided some run configurations for running the program from source:\n\n| Name | Description |\n|---------------------------------------------------|-----------------------------------------------------------------------------------------------------|\n| `all unit tests` | Runs all unit tests |\n| `generate site for example model (from git repo)` | Generates a site for the example model in `docs/example` from the remote Git repository on GitHub |\n| `generate site for example model (local)` | Generates a site for the example model in `docs/example` from the local clone of the Git repository |\n| `serve example model` | Starts a development server for the example model in `docs/example` |\n\n## Updating documentation\n\nAt the time of writing this document, the documentation of this tool is sparse. Please provide updated documentation\nwith your PR's, where applicable.\n\nThis is what's currently available:\n\n- There's some basic documentation available in [README.md](README.md), which describes the basic usage of this tool.\n- The default homepage (located in the `HomePageViewModel` class) provides some basic documentation on customizing the\n homepage.\n- Finally, there's the example model, which contains some documentation on embedding diagrams in documentation Markdown\n files.\n"
},
{
"path": "Dockerfile",
"content": "FROM eclipse-temurin:21.0.10_7-jre-jammy\n\nUSER root\nRUN apt update && apt install graphviz --yes && rm -rf /var/lib/apt/lists/*\nRUN mkdir -p /var/model \\\n && chown 65532:65532 /var/model\nRUN useradd -d /home/generatr -u 65532 --create-home generatr\n\nENTRYPOINT [\"/opt/structurizr-site-generatr/bin/structurizr-site-generatr\"]\n\nWORKDIR /opt/structurizr-site-generatr\nCOPY build/install/structurizr-site-generatr ./\nRUN chmod +x /opt/structurizr-site-generatr/bin/structurizr-site-generatr\n\nUSER generatr\nVOLUME [\"/var/model\"]\nWORKDIR /var/model\n"
},
{
"path": "LICENSE",
"content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "README.md",
"content": "\n* [Structurizr Site Generatr](#structurizr-site-generatr)\n * [Features](#features)\n * [Getting Started](#getting-started)\n * [Installation using Homebrew - Recommended](#installation-using-homebrew---recommended)\n * [Manual installation](#manual-installation)\n * [Docker](#docker)\n * [[Optional] Verify the Structurizr Site Generatr image with CoSign](#optional-verify-the-structurizr-site-generatr-image-with-cosign)\n * [Usage](#usage)\n * [Help](#help)\n * [Version](#version)\n * [Generate a website](#generate-a-website)\n * [From a C4 Workspace](#from-a-c4-workspace)\n * [For those taking the Docker approach](#for-those-taking-the-docker-approach)\n * [Generate a website from a Git repository](#generate-a-website-from-a-git-repository)\n * [Start a development web server around the generated website](#start-a-development-web-server-around-the-generated-website)\n * [For those taking the Docker approach](#for-those-taking-the-docker-approach-1)\n * [Customizing the generated website](#customizing-the-generated-website)\n * [Contributing](#contributing)\n * [Background](#background)\n\n\n# Structurizr Site Generatr\n\nA static site generator for [C4 architecture models](https://c4model.com/) created with [Structrizr DSL](https://docs.structurizr.com/dsl).\nSee [Background](#background) for the story behind this tool.\n\n[Click here to see an example of a generated site](https://avisi-cloud.github.io/structurizr-site-generatr) based on\nthe [Big Bank plc example](https://structurizr.com/dsl?example=big-bank-plc) from . This site\nis generated from the example workspace in this repository.\n\n## Features\n\n- Generate a static HTML site, based on a Structurizr DSL workspace.\n- Generates diagrams in SVG, PNG and PlantUML format, which can be viewed and downloaded from the generated site.\n- Easy browsing through the site by clicking on software system and container elements in the diagrams. Note that\n external software systems are excluded from the menu. A software system is considered external when it lives outside\n the (deprecated) enterprise boundary or when it contains a specific tag, see [Customizing the generated website](#customizing-the-generated-website). \n- Start a development server which generates a site, serves it and updates the site automatically whenever a file that's\n part of the Structurizr workspace changes.\n- Include documentation (in Markdown or AsciiDoc format) in the generated site. Both workspace level documentation and software\n system level documentation are included in the site.\n- Include ADR's in the generated site. Again, both workspace level ADR's and software system level ADR's are included in\n the site.\n- Include static assets in the generated site, which can be used in ADR's and documentation.\n- Generate a site from a Structurizr DSL model in a Git repository. Supports multiple branches, which makes it possible\n to for example maintain an actual state in `master` and one or more future states in feature branches. The generated\n site includes diagrams for all valid configured or detected branches.\n- Include a version number in the generated site.\n\n## Getting Started\n\nTo get started with the Structurizr Site Generatr, you can either:\n\n- Install it to your local machine (recommended for the best experience), or\n- Execute it on your local machine via a container (requires Docker)\n\n**Please note**: The intended use of the Docker image is to generate a site from a CI pipeline. Using it for model\ndevelopment is possible, but not a usage scenario that's actively supported.\n\n### Installation using Homebrew - Recommended\n\nAs this approach relies on [Homebrew](https://brew.sh/), ensure this is already installed. For Windows and other\noperating systems not supported by Homebrew, please use the [Docker approach](#docker) instead.\n\nTo install Structurizr Site Generatr execute the following commands in your terminal:\n\n```shell\nbrew tap avisi-cloud/tools\nbrew install structurizr-site-generatr\n\nstructurizr-site-generatr --help\n```\n\nPeriodically, you would have to update your local installation to take advantage of any new\n[Structurizr Site Generatr releases](https://github.com/avisi-cloud/structurizr-site-generatr/releases).\n\n### Manual installation\n\nIf using Homebrew is not an option for you, it's also possible to install Structurizr Site Generatr manually. This can\nbe done as follows:\n\n- Consult the\n [Structurizr Site Generatr releases](https://github.com/avisi-cloud/structurizr-site-generatr/releases) and choose\n the version you wish to use\n- Download the `.tar.gz` or `.zip` distribution\n- Extract the archive using your favourite tool\n- For ease of use, it's recommended to add Structurizr Site Generatr's `bin` directory to your `PATH`\n\n### Docker\n\nThough local installation is recommended for development where possible, Structurizr Site Generatr is also a packaged\nas a Docker image. Therefore, to use this approach, ensure [Docker](https://www.docker.com/) is already installed.\nAdditionally, for Windows 10+ users, you may want to take advantage of\n[WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) (Windows Subsystem for Linux). Both Docker and WSL2\nare topics too vast to repeat here, so you are invited to study these as prerequisite learning for this approach.\n\nThen to download our packaged image, consider the\n[Structurizr Site Generatr releases](https://github.com/avisi-cloud/structurizr-site-generatr/releases) and choose\nthe version you wish to use. Then, in your terminal, execute the following:\n\n```shell\ndocker pull ghcr.io/avisi-cloud/structurizr-site-generatr\n```\n\nOnce downloaded, you can execute Structurizr Site Generatr via a temporary Docker container by executing the\nfollowing in your terminal:\n\n```shell\ndocker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr --help\n```\n\n#### [Optional] Verify the Structurizr Site Generatr image with [CoSign](https://github.com/sigstore/cosign)\n\n```shell\ncat cosign.pub\n-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEzezKl0vAWSHosQ0JLEsDzNBd2nGm\n08KqX+imYqq2avlbH+ehprJFMqKK0/I/bY0q5W9hQC8SLzTRJ9Q5dB9UiQ==\n-----END PUBLIC KEY-----\ncosign verify --key cosign.pub ghcr.io/avisi-cloud/structurizr-site-generatr\n```\n\nOr by using the Github repo url:\n\n```shell\n cosign verify --key https://github.com/avisi-cloud/structurizr-site-generatr ghcr.io/avisi-cloud/structurizr-site-generatr\n ```\n\n## Usage\n\nThese examples use the [example workspace](docs/example) in this repository.\n\nOnce installed, Structurizr Site Generatr is operated via your terminal by issuing commands. Each command is\nexplained here:\n\n### Help\n\nTo learn about available commands, or parameters for individual commands, call Structurizr Site Generatr with the\n`--help` argument.\n\n```shell\ninstalled> structurizr-site-generatr --help\n\n docker> docker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr --help\n\nUsage: structurizr-site-generatr options_list\nSubcommands:\n serve - Start a development server\n generate-site - Generate a site for the selected workspace.\n version - Print version information\n\nOptions:\n --help, -h -> Usage info\n```\n\n### Version\n\nTo query the version of Structurizr Site Generatr installed / used.\n\n```shell\ninstalled> structurizr-site-generatr version\n\n docker> docker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr version\n\nStructurizr Site Generatr v1.1.3\n```\n\n### Generate a website\n\n#### From a [C4 Workspace](https://docs.structurizr.com/dsl)\n\nThis is the primary use case of Structurizr Site Generatr -- to generate a website from a\n[C4 Workspace](https://docs.structurizr.com/dsl).\n\n```shell\ninstalled> structurizr-site-generatr generate-site --workspace-file workspace.dsl --assets-dir assets\n\n docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr generate-site --workspace-file workspace.dsl --assets-dir assets\n```\n\nHere, the `--workspace-file` or `-w` parameter specifies the input\n[C4 Workspace DSL file](https://docs.structurizr.com/dsl) to the `generate-site` command. The `--assets-dir` or `-a` parameter is not\nrequired, but usually needed as well. Additional parameters that affect website generation can be reviewed\nusing the `--help` operator.\n\nBy default, the generated website will be placed in `./build`, which is overwritten if it already exisits.\n\n#### For those taking the Docker approach\n\nWhen using the Docker approach, the local file system must be made available to the temporary Structurizr Site\nGeneratr container via a\n[Docker file system volume mount](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only).\nThis is achieved by specifying the `-v` parameter with a linux-like **absolute** path to the folder containing\nthe .dsl file specified via `-w`. See how `C:\\Projects\\C4` has become `-v c:/projects/c4:/var/model` in the above\nexample?\n\n#### Generate a website from a Git repository\n\nInstead of relying on local .dsl files only, the `generate-site` command can also retrieve input files from a\nGit repository as follows. This is particularly advantageous for demos, documentation, or CI/CD pipelines.\n\nTo explicitly name the branches that you want to build sites from you can use the --branches option.\n\n```shell\nstructurizr-site-generatr generate-site\n --git-url https://github.com/avisi-cloud/structurizr-site-generatr.git\n --workspace-file docs/example/workspace.dsl\n --assets-dir docs/example/assets\n --branches main,future,old\n --default-branch main\n```\n\nor you can choose to build all branches that are found in the repository and exclude specific ones by using the --all-branches and --exclude-branches options.\n\n```shell\nstructurizr-site-generatr generate-site\n --git-url https://github.com/avisi-cloud/structurizr-site-generatr.git\n --workspace-file docs/example/workspace.dsl\n --assets-dir docs/example/assets\n --all-branches\n --exclude-branches gh-pages\n --default-branch main\n```\n\nBoth the --branches and --exclude-branches options are comma separated lists and can contain multiple branch names.\n\n### Start a development web server around the generated website\n\nTo aid composition of [C4 Workspace DSL files](https://docs.structurizr.com/dsl), the `serve` command will\ngenerate a website from the input .dsl specified with `-w` _and_ start a web server to view it. **Default port** for the web server is **8080**.\nA different port for the web server can be specified with `-p PORT`. Additional parameters that affect website generation and the development\nweb server can be reviewed using the `--help` operator.\n\n```shell\ninstalled> structurizr-site-generatr serve -w workspace.dsl\n\n docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr serve --workspace-file workspace.dsl --assets-dir assets\n```\n\nBy default, a development web server will be started and accessible at http://localhost:8080/ (if available).\n\n#### For those taking the Docker approach\n\nHowever, when using the Docker approach, this development web server is within the temporary Structurizr Site\nGeneratr container. So\n[Docker port mapping](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)\nis needed to expose the container's port 8080 to the host (web browser). In the example above, the\n`-p 8080:8080` argument tells Docker to bind the local machine / host's port 8080 to the container's port 8080.\n\n## Customizing the generated website\n\nBy default, the site generator uses the\n[C4PlantUmlExporter](https://docs.structurizr.com/export/plantuml#c4plantumlexporter)\nto generate the diagrams. When using this exporter, all properties available for the C4PlantUMLExporter, e.g. `c4plantuml.tags`, can be applied\nand affect the diagrams in the generate site. See also [Diagram notation](https://docs.structurizr.com/export/comparison) for an overview of supported features\nand limitations for this exporter.\n\nThe look and feel of the generated site can be customized with several additional view properties in the C4\narchitecture model:\n\n| Property name | Description | Default | Example |\n|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|------------------------------------------------------|\n| `generatr.style.colors.primary` | Primary site color, used for header bar background and active menu background. | `#333333` | `#485fc7` |\n| `generatr.style.colors.secondary` | Secondary site color, used for font color in header bar and for active menu. | `#cccccc` | `#ffffff` |\n| `generatr.style.faviconPath` | Site logo location relative to the configured `assets` folder. When configured, the logo image will be place on the left side in the header bar. This requires the `--assets-dir` switch when generating the site and the corresponding file to be available in the `assets` folder. | | `site/favicon.ico` |\n| `generatr.style.logoPath` | Site favicon location relative to the configured `assets` folder. When configured, the favicon will be set for all generated pages. This requires the `--assets-dir` switch when generating the site and the corresponding file to be available in the `assets` folder. | | `site/logo.png` |\n| `generatr.style.customStylesheet` | URL to hosted custom stylesheet or path to custom stylesheet file (location relative to the configured `assets` folder). When configured this css file will be loaded for all pages. When using a path to a file the `--assets-dir` switch must be used when generating the site and the corresponding file is available in the `assets` folder. | | `site/custom.css` or 'https://uri.example/custom.css |\n| `generatr.search.language` | Indexing/stemming language for the search index. See [Lunr language support](https://github.com/olivernn/lunr-languages) | `en` | `nl` |\n| `generatr.markdown.flexmark.extensions` | Additional extensions to the markdown generator to add new markdown capabilities. [More Details](https://avisi-cloud.github.io/structurizr-site-generatr/main/extended-markdown-features/) | Tables | `Tables,Admonition` |\n| `generatr.svglink.target` | Specifies the link target for element links in the exported svg | `_top` | `_self` |\n| `generatr.site.exporter` | Specifies the UML exporter, can be `c4` (uses the `C4PlantUMLExporter`) or `structurizr` (uses the `StructurizrPlantUMLExporter`) | `c4` | `structurizr` |\n| `generatr.site.externalTag` | Software systems containing this tag will be considered external | | |\n| `generatr.site.nestGroups` | Will show software systems in the left side navigator in collapsable groups | `false` | `true` |\n| `generatr.site.cdn` | Specifies the CDN base location for fetching NPM packages for browser runtime dependencies. Defaults to jsDelivr, but can be changed to e.g. an on-premise location. | `https://cdn.jsdelivr.net/npm` | `https://cdn.my-company/npm` |\n| `generatr.site.theme` | Experimental: allows to force a light or dark theme or allows to switch between light and dark mode on the website with browser preference or menu item. Possible values are 'light', 'dark' or 'auto'. Note that the 'structurizr' exporter (see 'generatr.site.exporter' setting) generally works better for the dark theme. | `light` | `auto` |\n\nTo control the behavior of views, apply the following properties:\n\n| Property name | Description | Value | Scope |\n|--------------------------------------|------------------------------------------------------------------------------|----------------------|-----------------|\n| `generatr.view.deployment.belongsTo` | Associate the diagram into the Deployment tab of a specific software system. | software system name | deployment view |\n\nSee the included example for usage of some those properties in the\n[C4 architecture model example](https://github.com/avisi-cloud/structurizr-site-generatr/blob/main/docs/example/workspace.dsl#L163).\n\n## Contributing\n\nWe welcome contributions! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how you can help.\n\n## Background\n\nAt Avisi, we're big fans of the [C4 model](https://c4model.com). We use it in many projects, big and small, to document\nthe architecture of the systems and system landscapes we're working on.\n\nWe started out by using PlantUML, combined with the [C4 extension](https://github.com/plantuml-stdlib/C4-PlantUML). This\nworks well for small systems. However, for larger application landscapes, maintained by multiple development teams, this\nlead to duplication and inconsistency across diagrams.\n\nTo solve this problem, we needed a model based approach. Rather than maintaining separate diagrams and trying to keep\nthem consistent, we needed to have a single model, from which diagrams could be generated. This is why we started using\nthe [Structurizr for Java](https://github.com/structurizr/java) library. About a year later, we migrated our models to\nStructurizr DSL.\n\nWe created custom tooling to generate diagrams and check them in to our Git repository. All diagrams could be seen by\nnavigating to our GitLab repository. This is less than ideal, because we like to make these diagrams easily accessible\nto everyone, including our customers. This is why we decided that we needed a way of publishing our models to an easily\naccessible website.\n\nThis tool is the result. It's still a work in progress, but it has already proven to be very useful to us.\n"
},
{
"path": "build.gradle.kts",
"content": "import org.gradle.api.tasks.testing.logging.TestExceptionFormat\nimport org.gradle.api.tasks.testing.logging.TestLogEvent\nimport org.jetbrains.kotlin.gradle.dsl.JvmTarget\n\nplugins {\n kotlin(\"jvm\") version \"2.3.20\"\n kotlin(\"plugin.serialization\") version \"2.3.20\"\n application\n}\n\ndescription = \"Structurizr Site Generatr\"\ngroup = \"cloud.avisi\"\n\nversion = project.properties[\"projectVersion\"] ?: \"0.0.0-SNAPSHOT\"\n\nrepositories {\n mavenCentral()\n}\n\ndependencies {\n implementation(platform(\"org.jetbrains.kotlin:kotlin-bom\"))\n implementation(\"org.jetbrains.kotlin:kotlin-stdlib\")\n implementation(\"org.jetbrains.kotlinx:kotlinx-cli:0.3.6\")\n\n implementation(\"org.eclipse.jgit:org.eclipse.jgit:7.6.0.202603022253-r\")\n\n implementation(\"com.structurizr:structurizr-core:6.1.0\")\n implementation(\"com.structurizr:structurizr-dsl:6.1.0\")\n implementation(\"com.structurizr:structurizr-export:6.1.0\")\n\n implementation(\"net.sourceforge.plantuml:plantuml:1.2026.2\")\n\n implementation(\"com.vladsch.flexmark:flexmark-all:0.64.8\")\n implementation(\"org.asciidoctor:asciidoctorj:3.0.1\")\n implementation(\"org.jsoup:jsoup:1.22.1\")\n\n implementation(\"org.jetbrains.kotlinx:kotlinx-html-jvm:0.12.0\")\n implementation(\"org.jetbrains.kotlinx:kotlinx-serialization-json:1.11.0\")\n\n implementation(\"org.eclipse.jetty:jetty-server:12.1.8\")\n implementation(\"org.eclipse.jetty.websocket:jetty-websocket-jetty-server:12.1.8\")\n\n runtimeOnly(\"org.slf4j:slf4j-simple:2.0.17\")\n\n // Support for Structurizr scripting languages\n runtimeOnly(\"org.jetbrains.kotlin:kotlin-scripting-jsr223:2.3.20\")\n runtimeOnly(\"org.codehaus.groovy:groovy-jsr223:3.0.25\")\n runtimeOnly(\"org.jruby:jruby-core:9.4.14.0\")\n\n testImplementation(kotlin(\"test\"))\n testImplementation(\"org.junit.jupiter:junit-jupiter-params\")\n testImplementation(\"com.willowtreeapps.assertk:assertk-jvm:0.28.1\")\n\n testImplementation(\"com.microsoft.playwright:playwright:1.59.0\")\n}\n\napplication {\n mainClass.set(\"nl.avisi.structurizr.site.generatr.AppKt\")\n}\n\nkotlin {\n jvmToolchain(21)\n compilerOptions {\n jvmTarget.set(JvmTarget.JVM_17)\n }\n}\n\njava {\n targetCompatibility = JavaVersion.VERSION_17\n}\n\ntasks {\n processResources {\n from(\"package.json\")\n }\n\n register(\"playwright\") {\n classpath(sourceSets[\"test\"].runtimeClasspath)\n mainClass = \"com.microsoft.playwright.CLI\"\n args = (project.properties[\"args\"] as String?)?.split(\" \") ?: emptyList()\n }\n\n test {\n useJUnitPlatform()\n systemProperty(\"file.encoding\", \"UTF-8\")\n testLogging.events = setOf(TestLogEvent.PASSED, TestLogEvent.FAILED, TestLogEvent.STANDARD_OUT, TestLogEvent.STANDARD_ERROR)\n testLogging.exceptionFormat = TestExceptionFormat.FULL\n }\n\n jar {\n manifest {\n attributes[\"Implementation-Title\"] = project.description\n attributes[\"Implementation-Version\"] = project.version\n }\n }\n\n startScripts {\n // This is a workaround for an issue with the generated .bat file,\n // reported in https://github.com/avisi-cloud/structurizr-site-generatr/issues/463.\n // Instead of listing each and every .jar file in the lib directory, we just use a\n // wildcard to include everything in the lib directory in the classpath.\n classpath = files(\"lib/*\")\n }\n\n withType {\n archiveExtension.set(\"tar.gz\")\n compression = Compression.GZIP\n }\n}\n"
},
{
"path": "cosign.pub",
"content": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEzezKl0vAWSHosQ0JLEsDzNBd2nGm\n08KqX+imYqq2avlbH+ehprJFMqKK0/I/bY0q5W9hQC8SLzTRJ9Q5dB9UiQ==\n-----END PUBLIC KEY-----\n"
},
{
"path": "docs/example/.adr-dir",
"content": "workspace-adrs\n"
},
{
"path": "docs/example/assets/site/custom.css",
"content": "svg g g[id^=\"link\"]:hover path {\n stroke:#FF0000 !important;\n stroke-width: 2.0;\n}\n\nsvg g g[id^=\"link\"]:hover polygon {\n stroke:#FF0000 !important;\n}\n\nsvg g g[id^=\"link\"]:hover text {\n fill:#FF0000 !important;\n}\n"
},
{
"path": "docs/example/internet-banking-system/adr/0001-record-architecture-decisions.md",
"content": "# 1. Record Internet Banking System architecture decisions\n\nDate: 2022-06-21\n\n## Status\n\nAccepted\n\n## Context\n\nWe need to record the architectural decisions made on this project.\n\n## Decision\n\nWe will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).\n\n## Consequences\n\nSee Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).\n"
},
{
"path": "docs/example/internet-banking-system/api-application/email-component/adr/0001-record-architecture-decisions.md",
"content": "# 1. Record Email Component architecture decision\n\nDate: 2022-06-21\n\n## Status\n\nAccepted\n\n## Context\n\nWe need to record the architectural decisions made on this project.\n\n## Decision\n\nWe will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).\n\n## Consequences\n\nSee Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).\n"
},
{
"path": "docs/example/internet-banking-system/api-application/email-component/adr/0002-implement-feature-1.md",
"content": "# 2. Implement Feature 1\n\nDate: 2024-12-17\n\n## Status\n\nSuperseded by [3. Another Realisation of Feature 1](0003-another-realisation-of-feature-1.md)\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/internet-banking-system/api-application/email-component/adr/0003-another-realisation-of-feature-1.md",
"content": "# 3. Another Realisation of Feature 1\n\nDate: 2024-12-17\n\n## Status\n\nAccepted\n\nSupersedes [2. Implement Feature 1](0002-implement-feature-1.md)\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/internet-banking-system/api-application/email-component/docs/0001-inner-workings.md",
"content": "# Email Component inner workings\n\nThis is how the e-mail component works.\n"
},
{
"path": "docs/example/internet-banking-system/api-application/mainframe-banking-system-facade/adr/0001-record-architecture-decisions.md",
"content": "# 1. Record Mainframe Banking System Facade architecture decision\n\nDate: 2022-06-21\n\n## Status\n\nAccepted\n\n## Context\n\nWe need to record the architectural decisions made on this project.\n\n## Decision\n\nWe will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).\n\n## Consequences\n\nSee Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).\n"
},
{
"path": "docs/example/internet-banking-system/api-application/mainframe-banking-system-facade/docs/0000-introduction.md",
"content": "# Mainframe Banking System Facade\n\nThis is the Mainframe Banking System Facade.\n"
},
{
"path": "docs/example/internet-banking-system/api-application/mainframe-banking-system-facade/docs/0001-inner-workings.md",
"content": "# Inner workings of Mainframe Banking System Facade\n\nThis is how the facade works.\n"
},
{
"path": "docs/example/internet-banking-system/database/adr/0004-using-oracle-database-schema.md",
"content": "# 4. Using Oracle database schema\n\nDate: 2025-11-13\n\n## Status\n\nAccepted\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/internet-banking-system/database/docs/0002-guide.md",
"content": "# Usage\n\nThis is how we use this thing.\n"
},
{
"path": "docs/example/internet-banking-system/docs/0000-introduction.md",
"content": "# Description\n\nThis is our fancy Internet Banking System.\n\n## Vision\n\nOne system to rule them all!\n\n## References\n\n- Source Code on GitHub: [https://github.com/avisi-cloud/structurizr-site-generatr]\n"
},
{
"path": "docs/example/internet-banking-system/docs/0001-history.md",
"content": "# History\n\nSome notes how we got to the current state.\n"
},
{
"path": "docs/example/internet-banking-system/docs/0002-guide.md",
"content": "# Usage\n\nThis is how we use this thing.\n"
},
{
"path": "docs/example/workspace-adrs/0001-record-architecture-decisions.md",
"content": "# 1. Record architecture decisions\n\nDate: 2022-06-21\n\n## Status\n\nAccepted\n\n## Context\n\nWe need to record the architectural decisions made on this project.\n\n## Decision\n\nWe will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).\n\n## Consequences\n\nSee Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).\n"
},
{
"path": "docs/example/workspace-adrs/0002-implement-feature-1.md",
"content": "# 2. Implement Feature 1\n\nDate: 2024-12-17\n\n## Status\n\nSuperseded by [3. Another Realisation of Feature 1](0003-another-realisation-of-feature-1.md)\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/workspace-adrs/0003-another-realisation-of-feature-1.md",
"content": "# 3. Another Realisation of Feature 1\n\nDate: 2024-12-17\n\n## Status\n\nAccepted\n\nSupersedes [2. Implement Feature 1](0002-implement-feature-1.md)\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/workspace-adrs/0004-using-oracle-database-schema.md",
"content": "# 4. Using Oracle database schema\n\nDate: 2025-11-13\n\n## Status\n\nAccepted\n\n## Context\n\nThe issue motivating this decision, and any context that influences or constrains the decision.\n\n## Decision\n\nThe change that we're proposing or have agreed to implement.\n\n## Consequences\n\nWhat becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\n"
},
{
"path": "docs/example/workspace-docs/00-index.md",
"content": "## Big Bank plc architecture\n\nThis site contains the C4 architecture model for Big Bank plc.\n\nThis page is the home page, because it is the first file in the `workspace-docs` directory, when the files are sorted\nalphabetically.\n"
},
{
"path": "docs/example/workspace-docs/01-embedding-diagrams-and-images.md",
"content": "## Embedding diagrams and images\n\nThis page showcases the ability to embed diagrams and static images in documentation.\n\n### Embedding diagrams\n\nDiagrams can be embedded using the `embed:` syntax:\n\n```markdown\n\n```\n\nSee also: \n\n#### Example: Embedded diagram\n\n\n\n### Embedding static images\n\nStatic assets can be included in the generated site, using the `--assets-dir` command-line flag. This flag can be used\nwith the `serve` command and the `generate-site` command.\n\nWhen, for example, you would like to embed a nice picture which is located in the `pictures` directory under the assets\ndirectory, you can do that as follows:\n\n```markdown\n\n```\n\n#### Example: Embedded picture\n\n[Sun](https://www.flickr.com/photos/schmollmolch/4937297813/), by Christian Scheja\n\n\n\n### Embedding PlantUML diagrams\n\nStructurizr Site Generatr supports rendering PlantUML embedded in Markdown files.\n\n#### Sequence diagram example\n\n````markdown\n```puml\n@startuml\nFoo -> Bar: doSomething()\n@enduml\n```\n````\n\n```puml\n@startuml\nFoo -> Bar: doSomething()\n@enduml\n```\n\n### Class diagram example\n\n````markdown\n```puml\n@startuml\nclass Foo {\n +property: String\n +foo()\n}\n\nclass Bar {\n -privateProperty: String\n +bar()\n}\n\nFoo ..> Bar: Uses\n@enduml\n```\n````\n\n```puml\n@startuml\nclass Foo {\n +property: String\n +foo()\n}\n\nclass Bar {\n -privateProperty: String\n +bar()\n}\n\nFoo ..> Bar: Uses\n@enduml\n```\n\n### Embedding mermaid diagrams\n\nStructurizr Site Generatr is supporting mermaid diagrams in markdown pages using the actual mermaid.js version.\nTherefore every diagram type, supported by mermaid may be used in markdown documentation files.\n\n* flowchart\n* sequence diagram\n* class diagram\n* state diagram\n* entity-relationship diagram\n* user journey\n* gantt chart\n* pie chart\n* requirement diagram\n* and some more\n\nPlease find the full list of supported chart types\non [mermaid.js.org/intro](https://mermaid.js.org/intro/#diagram-types)\n\n#### Flowchart Diagram Example\n\n````markdown\n```mermaid\ngraph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n```\n````\n\n```mermaid\ngraph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n```\n\n#### Sequence Diagram Example\n\n````markdown\n```mermaid\nsequenceDiagram\n participant Alice\n participant Bob\n Alice->>John: Hello John, how are you?\n loop Healthcheck\n John->>John: Fight against hypochondria\n end\n Note right of John: Rational thoughts prevail!\n John-->>Alice: Great!\n John->>Bob: How about you?\n Bob-->>John: Jolly good!\n```\n````\n\n```mermaid\nsequenceDiagram\n participant Alice\n participant Bob\n Alice->>John: Hello John, how are you?\n loop Healthcheck\n John->>John: Fight against hypochondria\n end\n Note right of John: Rational thoughts prevail!\n John-->>Alice: Great!\n John->>Bob: How about you?\n Bob-->>John: Jolly good!\n```\n"
},
{
"path": "docs/example/workspace-docs/02-markdown-features.md",
"content": "## Extended Markdown features\n\nThis page showcases the ability to use extended Markdown formating features in workspace documentation files. The full list of available extensions to standard commonmark markdown features is documented in the flexmark wiki [Extensions page](https://github.com/vsch/flexmark-java/wiki/Extensions).\n\nMost of these extended features have to be activated in your architecture model as a property in workspace views.\n\n```DSL\nworkspace {\n ...\n views {\n ...\n properties {\n ...\n // full list of available \"generatr.markdown.flexmark.extensions\":\n // - Abbreviation\n // - Admonition\n // - AnchorLink\n // - Aside\n // - Attributes\n // - Autolink\n // - Definition\n // - Emoji\n // - EnumeratedReference\n // - Footnotes\n // - GfmIssues\n // - GfmStrikethroughSubscript\n // - GfmTaskList\n // - GfmUsers\n // - GitLab\n // - Ins\n // - Macros\n // - MediaTags\n // - ResizableImage\n // - Superscript\n // - Tables\n // - TableOfContents\n // - SimulatedTableOfContents\n // - Typographic\n // - WikiLinks\n // - XWikiMacro\n // - YAMLFrontMatter\n // - YouTubeLink\n // see https://github.com/vsch/flexmark-java/wiki/Extensions\n // ATTENTION:\n // * \"generatr.markdown.flexmark.extensions\" values must be separated by comma\n // * it's not possible to use \"GitLab\" and \"ResizableImage\" extensions together\n // default behaviour, if no generatr.markdown.flexmark.extensions property is specified, is to load the Tables extension only\n \"generatr.markdown.flexmark.extensions\" \"Abbreviation,Admonition,AnchorLink,Attributes,Autolink,Definition,Emoji,Footnotes,GfmTaskList,GitLab,MediaTags,Tables,TableOfContents,Typographic\"\n ...\n }\n ...\n }\n ...\n}\n```\n\n### Table of Contents\n\n`[TOC]` element which renders a table of contents\n\n```markdown\n[TOC]\n```\n\nwill render into\n\n[TOC]\n\n#### Usage info\n\n\"TableOfContents\" is an optional feature, that has to be activated in workspace views properties\n\n```DSL\n \"generatr.markdown.flexmark.extensions\" \"TableOfContents\"\n```\n\n### Render Tables\n\nStandard tables can be embedded in markdown text syntax:\n\n```markdown\n| header1 | header2 |\n| ------- | ------- |\n| content | content |\n```\n\nThis will be rendered as\n\n| header1 | header2 |\n| ------- | ------- |\n| content | content |\n\n#### Usage info\n\n\"Render Tables\" is an optional feature, that is enabled by default. If other optional markdown features are activated in workspace views properties, than you have to ensure, that Tables is listed in the extension list as well.\n\n```DSL\n \"generatr.markdown.flexmark.extensions\" \"Tables\"\n```\n\n### Admonition Blocks\n\nAdmonitions create block-styled side content.\n\n```markdown\n!!! faq \"FAQ\"\n This is a FAQ.\n!!! attention \"Warning\"\n This is a warning message\n\n!!! info \"information\"\n this is an additional information\n```\n\nThis will be rendered as\n\n!!! faq \"FAQ\"\n This is a FAQ.\n!!! attention \"Warning\"\n This is a warning message\n\n!!! info \"information\"\n this is an additional information\n\n#### Usage info\n\n\"Admonition Blocks\" is an optional feature, that has to be activated in workspace views properties\n\n```DSL\n \"generatr.markdown.flexmark.extensions\" \"Admonition\"\n```\n\n### GitLab flavored markdown extensions\n\nPlease see [GitLab flavored markdown features](https://docs.gitlab.com/ee/user/markdown.html?tab=Rendered+Markdown) for a detailed description.\nUnfortunately only the following features are supported by Flexmark markdown renderer, that is used here.\n\n#### Multiline Block quote delimiters\n\n```markdown\n>>>\nIf you paste a message from somewhere else\n\nthat spans multiple lines,\n\nyou can quote that without having to manually prepend `>` to every line!\n>>>\n```\n\n>>>\nIf you paste a message from somewhere else\n\nthat spans multiple lines,\n\nyou can quote that without having to manually prepend `>` to every line!\n>>>\n\n#### Inline diff (deletions and additions)\n\nWith inline diff tags, you can display `{+ additions +}` or `[- deletions -]`.\n\nThe wrapping tags can be either curly braces or square brackets:\n\n```markdown\n- {+ addition 1 +}\n- [+ addition 2 +]\n- {- deletion 3 -}\n- [- deletion 4 -]\n```\n\n- {+ addition 1 +}\n- [+ addition 2 +]\n- {- deletion 3 -}\n- [- deletion 4 -]\n\n#### Math\n\nMath written in LaTeX syntax is rendered with [KaTeX](https://github.com/KaTeX/KaTeX).\n_KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._\n\nMath written between dollar signs with backticks (``$`...`$``) or single dollar signs (`$...$`)\nis rendered inline with the text.\n\nMath written between double dollar signs (`$$...$$`) or in a code block with\nthe language declared as `math` is rendered on a separate line:\n\n````markdown\nThis math is inline: $`a^2+b^2=c^2`$.\n\nThis math is on a separate line using a ```` ```math ```` block:\n\n```math\na^2+b^2=c^2\n```\n````\n\nThis math is inline: $`a^2+b^2=c^2`$.\n\nThis math is on a separate line using a ```` ```math ```` block:\n\n```math\na^2+b^2=c^2\n```\n\n#### Usage info\n\n\"GitLab Flavored Markdown\" is an optional feature, that has to be activated in workspace views properties\n\n```DSL\n \"generatr.markdown.flexmark.extensions\" \"GitLab\"\n```\n\n### AnchorLink\n\nAutomatically adds anchor links to headings, using GitHub id generation algorithm\n\n#### Usage info\n\n\"AnchorLink\" is an optional feature, that has to be activated in workspace views properties\n\n```DSL\n \"generatr.markdown.flexmark.extensions\" \"AnchorLink\"\n```\n\n### Definition Lists\n\nConverts definition syntax of Php Markdown Extra Definition List to `
\ndocument.querySelectorAll(\"pre.mermaid, pre>code.language-mermaid, div.mermaid\").forEach($el => {\n // if the second selector got a hit, reference the parent
\n if ($el.tagName === \"CODE\")\n $el = $el.parentElement\n // put the Mermaid contents in the expected
\n // plus keep the original contents in a nice \n $el.outerHTML = `\n
${$el.textContent}
\n \n Diagram source\n
${$el.textContent}
\n \n `\n })"
},
{
"path": "src/main/resources/assets/js/search.js",
"content": "window.onpageshow = function() {\n const el = document.getElementById('search');\n el.focus();\n\n const params = new URLSearchParams(window.location.search);\n const terms = params.get('q');\n\n if (terms) {\n el.value = terms;\n search(terms);\n }\n};\n\nfunction search(terms) {\n const results = idx.search(terms).map(item => {\n const document = documents.find(post => item.ref === post.href);\n return { score: item.score, href: document.href, type: document.type, title: document.title };\n });\n\n const div = document.getElementById('search-results');\n clearResultElements(div);\n\n if (results.length === 0) {\n div.appendChild(createNoResultsElement());\n } else {\n results.forEach(result => {\n div.appendChild(createResultElement(result));\n });\n }\n}\n\nfunction clearResultElements(div) {\n while (div.firstChild) {\n div.removeChild(div.firstChild);\n }\n}\n\nfunction createResultElement(result) {\n const p = document.createElement('p');\n\n const link = document.createElement('a');\n link.href = result.href;\n const title = document.createElement('p');\n title.innerText = result.title;\n title.className = 'mb-0';\n\n const type = document.createElement('small');\n type.innerText = result.type;\n\n link.appendChild(title);\n p.appendChild(link);\n p.appendChild(type);\n return p;\n}\n\nfunction createNoResultsElement() {\n const p = document.createElement('p');\n const small = document.createElement('small');\n small.className = 'is-italic';\n small.innerText = 'Your search yielded no results';\n\n p.appendChild(small);\n return p;\n}\n"
},
{
"path": "src/main/resources/assets/js/svg-modal.js",
"content": "let pz = undefined;\n\nfunction resetPz() {\n if (pz) {\n pz.resize();\n pz.center();\n pz.reset();\n }\n}\n\nfunction openSvgModal(id, svgId) {\n openModal(id);\n\n const svgElement = document.getElementById(svgId).firstElementChild;\n svgElement.classList.add('modal-svg');\n\n pz = svgPanZoom(svgElement, {\n zoomEnabled: true,\n controlIconsEnabled: true,\n fit: true,\n center: true,\n minZoom: 1,\n maxZoom: 5\n });\n resetPz();\n\n // Reset position on window resize\n window.addEventListener('resize', resetPz);\n}\n\nfunction closeSvgModal(id) {\n if (pz) {\n pz.destroy();\n }\n closeModal(id);\n}\n"
},
{
"path": "src/main/resources/assets/js/toggle-theme.js",
"content": "if (!localStorage.getItem(\"data-theme\")) {\n const prefersDarkMode = window.matchMedia &&\n window.matchMedia('(prefers-color-scheme: dark)').matches;\n\n localStorage.setItem(\"data-theme\", prefersDarkMode ? \"dark\" : \"light\");\n}\n\ndocument.documentElement.setAttribute(\"data-theme\", localStorage.getItem(\"data-theme\"));\n\nfunction toggleTheme() {\n if (localStorage.getItem(\"data-theme\") === \"light\") {\n document.documentElement.setAttribute(\"data-theme\", \"dark\");\n localStorage.setItem(\"data-theme\", \"dark\");\n } else {\n document.documentElement.setAttribute(\"data-theme\", \"light\");\n localStorage.setItem(\"data-theme\", \"light\");\n }\n}\n"
},
{
"path": "src/main/resources/assets/js/treeview.js",
"content": "function listree() {\n\n const subMenuHeadingClass = \"listree-submenu-heading\";\n const expandedClass = \"expanded\";\n const collapsedClass = \"collapsed\";\n const activeClass = \"is-active\";\n const subMenuHeadings = document.getElementsByClassName(subMenuHeadingClass);\n\n Array\n .from(subMenuHeadings)\n .forEach(function(subMenuHeading) {\n // Collapse all the subMenuHeadings while searching for is-active class\n let foundActive = false;\n subMenuHeading.classList.add(collapsedClass);\n subMenuHeading.nextElementSibling.style.display = \"none\";\n\n // Check if this sub-menu heading is active\n const liElements = subMenuHeading.nextElementSibling.children;\n for (let i = 0; i < liElements.length; i++) {\n if (liElements[i].hasChildNodes()) {\n if (liElements[i].children[0].tagName === \"A\") {\n if (liElements[i].children[0].classList.contains(activeClass)) {\n foundActive = true;\n break;\n }\n }\n }\n }\n\n // Expand all parent sub-menus until root menu is reached\n if (foundActive) {\n subMenuHeading.classList.remove(collapsedClass);\n subMenuHeading.classList.add(expandedClass);\n subMenuHeading.nextElementSibling.style.display = \"block\";\n\n let currentSubMenu = subMenuHeading.parentElement;\n while (currentSubMenu !== null && !currentSubMenu.classList.contains(\"listree\")) {\n if(currentSubMenu.tagName === \"UL\"){\n if(currentSubMenu.previousElementSibling != null) {\n currentSubMenu.previousElementSibling.classList.remove(collapsedClass);\n currentSubMenu.previousElementSibling.classList.add(expandedClass);\n currentSubMenu.style.display = \"block\";\n }\n }\n currentSubMenu = currentSubMenu.parentElement\n }\n }\n\n // Add the eventlistener to all subMenuHeadings\n subMenuHeading.addEventListener(\"click\", function(event) {\n event.preventDefault();\n const subMenuList = event.target.nextElementSibling;\n if (subMenuList.style.display === \"none\") {\n subMenuHeading.classList.remove(collapsedClass);\n subMenuHeading.classList.add(expandedClass);\n subMenuHeading.nextElementSibling.style.display = \"block\";\n } else {\n subMenuHeading.classList.remove(expandedClass);\n subMenuHeading.classList.add(collapsedClass);\n subMenuHeading.nextElementSibling.style.display = \"none\";\n }\n event.stopPropagation();\n });\n });\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/BranchComparatorTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site\n\nimport assertk.assertThat\nimport assertk.assertions.containsExactly\nimport nl.avisi.structurizr.site.generatr.branchComparator\nimport org.junit.jupiter.api.DynamicTest\nimport org.junit.jupiter.api.TestFactory\n\nclass BranchComparatorTest {\n @TestFactory\n fun `default branch first then by string`() = listOf(\n listOf(\"a\", \"B\", \"main\"),\n listOf(\"a\", \"main\", \"B\"),\n listOf(\"B\", \"a\", \"main\"),\n listOf(\"B\", \"main\", \"a\"),\n listOf(\"main\", \"a\", \"B\"),\n listOf(\"main\", \"B\", \"a\"),\n ).map { branches ->\n DynamicTest.dynamicTest(branches.toString()) {\n assertThat(branches.sortedWith(branchComparator(\"main\")))\n .containsExactly(\"main\", \"a\", \"B\")\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/PlantUmlExporterTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site\n\nimport assertk.assertThat\nimport assertk.assertions.contains\nimport assertk.assertions.isEqualTo\nimport com.structurizr.Workspace\nimport org.junit.jupiter.api.DynamicTest\nimport org.junit.jupiter.api.TestFactory\nimport kotlin.test.Test\n\nclass PlantUmlExporterTest {\n @TestFactory\n fun `adds skinparam to remove explicit size from generated svg`() = exporters().map { (type, exporterFn) ->\n DynamicTest.dynamicTest(\"($type)\") {\n val workspace = createWorkspaceWithOneSystem()\n\n val diagram = exporterFn(workspace, \"/landscape/\").export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition)\n .contains(\"skinparam svgDimensionStyle false\")\n }\n }\n\n @TestFactory\n fun `adds skinparam to preserve the aspect ratio of the generated svg`() = exporters().map { (type, exporterFn) ->\n DynamicTest.dynamicTest(\"($type)\") {\n val workspace = createWorkspaceWithOneSystem()\n\n val diagram = exporterFn(workspace, \"/landscape/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition)\n .contains(\"skinparam preserveAspectRatio meet\")\n }\n }\n\n private fun exporters() = listOf(\n ExporterType.C4.name.lowercase() to\n { workspace: Workspace, url: String -> C4PlantUmlExporterWithElementLinks(workspace, url) },\n ExporterType.STRUCTURIZR.name.lowercase() to\n { workspace: Workspace, url: String -> StructurizrPlantUmlExporterWithElementLinks(workspace, url) }\n )\n\n @Test\n fun `renders diagram (c4)`() {\n val workspace = createWorkspaceWithOneSystem()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders diagram (structurizr)`() {\n val workspace = createWorkspaceWithOneSystem()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders System Diagram with link to container (c4)`() {\n val workspace = createWorkspaceWithOneSystemWithContainers()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-1/container/\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders System Diagram with link to container (structurizr)`() {\n val workspace = createWorkspaceWithOneSystemWithContainers()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1 [[../system-1/container/]]\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders System Diagram with link to other system and link to container (c4)`() {\n val workspace = createSystemContextViewForWorkspaceWithTwoSystemWithContainers()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-1/container/\")\n System(System2, \"System 2\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-2/context/\")\n\n Rel(System2, System1, \"uses\", ${'$'}techn=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders System Diagram with link to other system and link to container (structurizr)`() {\n val workspace = createSystemContextViewForWorkspaceWithTwoSystemWithContainers()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1 [[../system-1/container/]]\n rectangle \"==System 2\\n[Software System]\" <> as System2 [[../system-2/context/]]\n\n System2 --> System1 <> : \"uses\"\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Container Diagram with link to component diagram (c4)`() {\n val workspace = createWorkspaceWithOneSystemWithContainersAndComponents()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.containerViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System_Boundary(\"System1_boundary\", \"System 1\", ${'$'}tags=\"\") {\n Container(System1.Container1, \"Container 1\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-1/component/container-1/\")\n }\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Container Diagram with link to component diagram (structurizr)`() {\n val workspace = createWorkspaceWithOneSystemWithContainersAndComponents()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.containerViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"System 1\\n[Software System]\" <> {\n rectangle \"==Container 1\\n[Container]\" <> as System1.Container1 [[../system-1/component/container-1/]]\n }\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Container Diagram with link to code view (c4)`() {\n val workspace = createWorkspaceWithOneSystemWithContainersComponentAndImage()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.componentViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System_Boundary(\"System1_boundary\", \"System 1\", ${'$'}tags=\"\") {\n Container_Boundary(\"System1.Container1_boundary\", \"Container 1\", ${'$'}tags=\"\") {\n Component(System1.Container1.Component1, \"Component 1\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-1/code/container-1/component-1/\")\n Component(System1.Container1.Component2, \"Component 2\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n Component(System1.Container1.Component3, \"Component 3\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n }\n\n }\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Container Diagram with link to code view (structurizr)`() {\n val workspace = createWorkspaceWithOneSystemWithContainersComponentAndImage()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/container/\")\n .export(workspace.views.componentViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"System 1\\n[Software System]\" <> {\n rectangle \"Container 1\\n[Container]\" <> {\n rectangle \"==Component 1\\n[Component]\" <> as System1.Container1.Component1 [[../system-1/code/container-1/component-1/]]\n rectangle \"==Component 2\\n[Component]\" <> as System1.Container1.Component2\n rectangle \"==Component 3\\n[Component]\" <> as System1.Container1.Component3\n }\n\n }\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Components Diagram without link to other Component Diagram (c4)`() {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n val container1 = system.addContainer(\"Container 1\")\n val container2 = system.addContainer(\"Container 2\")\n container1.addComponent(\"Component 1\").apply { uses(container2, \"uses\") }\n container2.addComponent(\"Component 2\")\n\n val view = workspace.views.createComponentView(container1, \"Component2\", \"\")\n .apply { addAllElements() }\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/system-1/component/\")\n .export(view)\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System_Boundary(\"System1_boundary\", \"System 1\", ${'$'}tags=\"\") {\n Container_Boundary(\"System1.Container1_boundary\", \"Container 1\", ${'$'}tags=\"\") {\n Component(System1.Container1.Component1, \"Component 1\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n }\n\n Container(System1.Container2, \"Container 2\", ${'$'}techn=\"\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n }\n\n Rel(System1.Container1.Component1, System1.Container2, \"uses\", ${'$'}techn=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders Components Diagram without link to other Component Diagram (structurizr)`() {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n val container1 = system.addContainer(\"Container 1\")\n val container2 = system.addContainer(\"Container 2\")\n container1.addComponent(\"Component 1\").apply { uses(container2, \"uses\") }\n container2.addComponent(\"Component 2\")\n\n val view = workspace.views.createComponentView(container1, \"Component2\", \"\")\n .apply { addAllElements() }\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/system-1/component/\")\n .export(view)\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"System 1\\n[Software System]\" <> {\n rectangle \"Container 1\\n[Container]\" <> {\n rectangle \"==Component 1\\n[Component]\" <> as System1.Container1.Component1\n }\n\n rectangle \"==Container 2\\n[Container]\" <> as System1.Container2\n }\n\n System1.Container1.Component1 --> System1.Container2 <> : \"uses\"\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `link to other software system (c4)`() {\n val workspace = createWorkspaceWithTwoSystems()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n System(System2, \"System 2\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../system-2/context/\")\n\n Rel(System2, System1, \"uses\", ${'$'}techn=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `link to other software system (structurizr)`() {\n val workspace = createWorkspaceWithTwoSystems()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1\n rectangle \"==System 2\\n[Software System]\" <> as System2 [[../system-2/context/]]\n\n System2 --> System1 <> : \"uses\"\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `external software system (declared external by tag) (c4)`() {\n val workspace = createWorkspaceWithTwoSystems()\n workspace.views.configuration.addProperty(\"generatr.site.externalTag\", \"External System\")\n workspace.model.softwareSystems.single { it.name == \"System 2\" }.addTags(\"External System\")\n val view = workspace.views.systemContextViews.first()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(view)\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n System(System2, \"System 2\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n\n Rel(System2, System1, \"uses\", ${'$'}techn=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `external software system (declared external by tag) (structurizr)`() {\n val workspace = createWorkspaceWithTwoSystems()\n workspace.views.configuration.addProperty(\"generatr.site.externalTag\", \"External System\")\n workspace.model.softwareSystems.single { it.name == \"System 2\" }.addTags(\"External System\")\n val view = workspace.views.systemContextViews.first()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/landscape/\")\n .export(view)\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1\n rectangle \"==System 2\\n[Software System]\" <> as System2\n\n System2 --> System1 <> : \"uses\"\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `link to other software system from two path segments deep (c4)`() {\n val workspace = createWorkspaceWithTwoSystems()\n\n val diagram = C4PlantUmlExporterWithElementLinks(workspace, \"/system-1/context/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutC4HeaderAndFooter()).isEqualTo(\n \"\"\"\n System(System1, \"System 1\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n System(System2, \"System 2\", ${'$'}descr=\"\", ${'$'}tags=\"\", ${'$'}link=\"../../system-2/context/\")\n\n Rel(System2, System1, \"uses\", ${'$'}techn=\"\", ${'$'}tags=\"\", ${'$'}link=\"\")\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `link to other software system from two path segments deep (structurizr)`() {\n val workspace = createWorkspaceWithTwoSystems()\n\n val diagram = StructurizrPlantUmlExporterWithElementLinks(workspace, \"/system-1/context/\")\n .export(workspace.views.systemContextViews.first())\n\n assertThat(diagram.definition.withoutStructurizrHeaderAndFooter()).isEqualTo(\n \"\"\"\n rectangle \"==System 1\\n[Software System]\" <> as System1\n rectangle \"==System 2\\n[Software System]\" <> as System2 [[../../system-2/context/]]\n\n System2 --> System1 <> : \"uses\"\n \"\"\".trimIndent()\n )\n }\n\n private fun createWorkspaceWithOneSystem(): Workspace {\n val workspace = Workspace(\"workspace name\", \"\").apply {\n views.configuration.addProperty(\"generatr.site.excludedTag\", \"External System\")\n }\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n\n workspace.views.createSystemContextView(system, \"Context1\", \"\")\n .apply { addAllElements() }\n\n return workspace\n }\n\n private fun createWorkspaceWithOneSystemWithContainers(): Workspace {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n system.addContainer(\"Container 1\")\n system.addContainer(\"Container 2\")\n\n workspace.views.createSystemContextView(system, \"Context 1\", \"\")\n .apply { addAllElements() }\n\n workspace.views.createContainerView(system, \"Container1\", \"\")\n .apply { addAllElements() }\n\n return workspace\n }\n\n private fun createSystemContextViewForWorkspaceWithTwoSystemWithContainers(): Workspace {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n workspace.model.addSoftwareSystem(\"System 2\").apply { uses(system, \"uses\") }\n system.addContainer(\"Container 1\")\n system.addContainer(\"Container 2\")\n\n workspace.views.createSystemContextView(system, \"Context 1\", \"\")\n .apply { addAllElements() }\n\n workspace.views.createContainerView(system, \"Container1\", \"\")\n .apply { addAllElements() }\n\n return workspace\n }\n\n private fun createWorkspaceWithOneSystemWithContainersAndComponents(): Workspace {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n val container = system.addContainer(\"Container 1\")\n container.addComponent(\"Component 1\")\n container.addComponent(\"Component 2\")\n container.addComponent(\"Component 3\")\n\n workspace.views.createSystemContextView(system, \"Context 1\", \"\")\n .apply { addAllElements() }\n\n workspace.views.createContainerView(system, \"Container1\", \"\")\n .apply { addAllElements() }\n\n workspace.views.createComponentView(container, \"Component1\", \"\")\n .apply { addAllElements() }\n\n return workspace\n }\n\n private fun createWorkspaceWithOneSystemWithContainersComponentAndImage() = createWorkspaceWithOneSystemWithContainersAndComponents().apply {\n views.createImageView(model.softwareSystems.single().containers.single().components.single { it.name == \"Component 1\" }, \"imageview-001\").also {\n it.description = \"Image View Description\"\n it.title = \"Image View Title\"\n it.contentType = \"image/png\"\n it.content = \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=\"\n }\n }\n\n private fun createWorkspaceWithTwoSystems(): Workspace {\n val workspace = Workspace(\"workspace name\", \"\")\n val system = workspace.model.addSoftwareSystem(\"System 1\")\n workspace.model.addSoftwareSystem(\"System 2\").apply { uses(system, \"uses\") }\n\n workspace.views.createSystemContextView(system, \"Context 1\", \"\")\n .apply { addAllElements() }\n\n return workspace\n }\n\n private fun String.withoutC4HeaderAndFooter() = this\n .split(System.lineSeparator())\n .dropWhile { !it.startsWith(\"System\") && !it.startsWith(\"Container\") }\n .dropLast(3)\n .joinToString(System.lineSeparator())\n .trimEnd()\n\n private fun String.withoutStructurizrHeaderAndFooter() = this\n .split(System.lineSeparator())\n .dropWhile { !it.startsWith(\"rectangle\") }\n .dropLast(1)\n .joinToString(System.lineSeparator())\n .trimEnd()\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/StringUtilitiesTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site\n\nimport assertk.assertThat\nimport assertk.assertions.isEqualTo\nimport nl.avisi.structurizr.site.generatr.normalize\nimport org.junit.jupiter.api.DynamicTest\nimport org.junit.jupiter.api.TestFactory\n\nclass StringUtilitiesTest {\n\n @TestFactory\n fun `normalize strips invalid chars`() = listOf(\n listOf(\"doc\", \"doc\"),\n listOf(\"d c\", \"d-c\"),\n listOf(\"doc:\", \"doc\"),\n listOf(\" doc \", \"-doc-\"),\n listOf(\"aux\", \"aux-\"),\n ).map { (actual, expected) ->\n DynamicTest.dynamicTest(\"normalize replaces $actual with $expected\") {\n assertThat(actual.normalize()).isEqualTo(expected)\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/StructurizrUtilitiesTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site\n\nimport assertk.assertThat\nimport assertk.assertions.isEqualTo\nimport com.structurizr.Workspace\nimport nl.avisi.structurizr.site.generatr.includedProperties\nimport kotlin.test.Test\n\nclass StructurizrUtilitiesTest {\n\n private val svgFactory = { _: String, _: String -> \"\" }\n\n private fun generatorContext(\n workspaceName: String = \"Workspace name\",\n branches: List = listOf(\"main\"),\n currentBranch: String = \"main\",\n version: String = \"1.0.0\"\n ) = GeneratorContext(version, Workspace(workspaceName, \"\"), branches, currentBranch, false, svgFactory)\n\n @Test\n fun `includedProperties filters out structurizr and generatr properties`() {\n val element = generatorContext().workspace.model.addSoftwareSystem(\"System 1\")\n element.addProperty(\"structurizr.key\", \"value\")\n element.addProperty(\"generatr.key\", \"value\")\n element.addProperty(\"structurizrnotquite.key\", \"value\")\n element.addProperty(\"generatrbut.not.key\", \"value\")\n element.addProperty(\"other.key\", \"value\")\n\n val includedProperties = element.includedProperties\n\n assertThat(includedProperties.size).isEqualTo(3)\n assertThat(includedProperties.keys).isEqualTo(setOf(\"structurizrnotquite.key\", \"generatrbut.not.key\", \"other.key\"))\n }\n\n @Test\n fun `includedProperties returns all properties when none are filtered out`() {\n val element = generatorContext().workspace.model.addSoftwareSystem(\"System 1\")\n element.addProperty(\"key1\", \"value1\")\n element.addProperty(\"key2\", \"value2\")\n\n val includedProperties = element.includedProperties\n\n assertThat(includedProperties.size).isEqualTo(2)\n assertThat(includedProperties.keys.first()).isEqualTo(\"key1\")\n assertThat(includedProperties.keys.last()).isEqualTo(\"key2\")\n }\n\n @Test\n fun `includedProperties returns empty map when no properties are set`() {\n val element = generatorContext().workspace.model.addSoftwareSystem(\"System 1\")\n val includedProperties = element.includedProperties\n assertThat(includedProperties.size).isEqualTo(0)\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/E2ETestFixture.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport assertk.assertThat\nimport assertk.assertions.isTrue\nimport com.microsoft.playwright.Browser\nimport com.microsoft.playwright.BrowserContext\nimport com.microsoft.playwright.Page\nimport com.microsoft.playwright.Playwright\nimport nl.avisi.structurizr.site.generatr.main\nimport org.junit.jupiter.api.*\nimport org.junit.jupiter.api.extension.ExtendWith\nimport java.io.IOException\nimport java.net.BindException\nimport java.net.URI\nimport java.net.http.HttpClient\nimport java.net.http.HttpRequest\nimport java.net.http.HttpResponse\nimport java.time.Duration\n\n@ExtendWith(RetryExtension::class)\n@TestInstance(TestInstance.Lifecycle.PER_CLASS)\nabstract class E2ETestFixture {\n companion object {\n @JvmStatic\n protected val PORT = 9999\n\n @JvmStatic\n protected val SITE_URL = \"http://127.0.0.1:$PORT\"\n }\n\n private lateinit var serverThread: Thread\n private lateinit var playwright: Playwright\n private lateinit var browser: Browser\n private lateinit var context: BrowserContext\n protected lateinit var page: Page\n\n @BeforeAll\n @Order(1)\n fun serveExampleSite() {\n serverThread = Thread(::serve).apply {\n isDaemon = true\n start()\n }\n\n var reachable = false\n var count = 0\n while (!reachable && count++ < 1000) {\n reachable = siteIsReachable()\n\n Thread.sleep(Duration.ofMillis(100))\n }\n assertThat(reachable, name = \"site reachable\").isTrue()\n }\n\n @BeforeAll\n @Order(2)\n fun launchBrowser() {\n playwright = Playwright.create()\n browser = playwright.chromium().launch()\n }\n\n @BeforeEach\n @Order(1)\n fun createContextAndPage() {\n context = browser.newContext()\n page = context.newPage()\n }\n\n @AfterEach\n fun closeContext() {\n context.close()\n }\n\n @AfterAll\n fun closeBrowser() {\n playwright.close()\n serverThread.interrupt()\n }\n\n private fun serve() {\n try {\n main(arrayOf(\"serve\", \"-w\", \"docs/example/workspace.dsl\", \"-p\", PORT.toString()))\n } catch (_: InterruptedException) {\n // ignore, server shutdown\n } catch (exception: IOException) {\n if (exception.cause !is BindException) {\n throw exception\n }\n }\n }\n\n private fun siteIsReachable(): Boolean {\n try {\n val response = HttpClient\n .newBuilder()\n .connectTimeout(Duration.ofMillis(250))\n .build()\n .send(HttpRequest.newBuilder(URI.create(\"http://127.0.0.1:$PORT\")).GET().build(), HttpResponse.BodyHandlers.ofString())\n return response.statusCode() == 200 && response.body().contains(\"Structurizr site generatr\")\n } catch (_: IOException) {\n return false\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/PageTestHelper.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.Page\nimport com.microsoft.playwright.assertions.LocatorAssertions\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\n\nclass PageTestHelper {\n fun testMenu(page: Page, additionalActions: (Locator) -> Unit) {\n val menu = page.locator(\".menu > *\")\n\n val general = menu.nth(0)\n val softwareSystems = menu.nth(2)\n\n assertThat(general).containsText(\"GENERAL\", LocatorAssertions.ContainsTextOptions().setUseInnerText(true))\n assertThat(softwareSystems).containsText(\"SOFTWARE SYSTEMS\", LocatorAssertions.ContainsTextOptions().setUseInnerText(true))\n\n val generalMenu = menu.nth(1).locator(\"a\")\n val softwareSystemsMenu = menu.nth(3).locator(\"a\")\n\n val generalMenuTexts = listOf(\n \"Home\",\n \"Decisions\",\n \"Software Systems\",\n \"Embedding diagrams and images\",\n \"Extended Markdown features\",\n \"AsciiDoc features\"\n )\n\n generalMenuTexts.forEachIndexed { index, text ->\n assertThat(generalMenu.nth(index)).containsText(text)\n }\n\n val softwareSystemsMenuTexts = listOf(\n \"ATM\",\n \"E-mail System\",\n \"Internet Banking System\",\n \"Mainframe Banking System\"\n )\n\n softwareSystemsMenuTexts.forEachIndexed { index, text ->\n assertThat(softwareSystemsMenu.nth(index)).containsText(text)\n }\n\n additionalActions(menu)\n }\n\n fun testTitleAndSubtitle(page: Page, title: String, subtitle: String) {\n val titleLocator = page.locator(\".container > .title\")\n val subtitleLocator = page.locator(\".container > .subtitle\")\n\n assertThat(titleLocator).containsText(title)\n assertThat(subtitleLocator).containsText(subtitle)\n }\n\n fun testTabs(page: Page, additionalActions: (Locator) -> Unit) {\n val tabs = page.locator(\".container > .tabs > ul > li\")\n\n val tabTexts = listOf(\n \"Info\",\n \"Context views\",\n \"Container views\",\n \"Component views\",\n \"Code views\",\n \"Dynamic views\",\n \"Deployment views\",\n \"Dependencies\",\n \"Decisions\",\n \"Documentation\"\n )\n\n tabTexts.forEachIndexed { index, text ->\n assertThat(tabs.nth(index)).containsText(text)\n }\n\n additionalActions(tabs)\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/RetryExtension.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport org.junit.jupiter.api.extension.ExtensionContext\nimport org.junit.jupiter.api.extension.TestExecutionExceptionHandler\n\nclass RetryExtension : TestExecutionExceptionHandler {\n companion object {\n private const val MAX_RETRIES = 3\n\n private val namespace: ExtensionContext.Namespace = ExtensionContext.Namespace.create(\"RetryExtension\")\n }\n\n override fun handleTestExecutionException(\n context: ExtensionContext,\n throwable: Throwable\n ) {\n val store = context.getStore(namespace)\n val retries = store.getOrDefault(\"retries\", Int::class.java, 0)\n\n if (retries < MAX_RETRIES) {\n store.put(\"retries\", retries + 1)\n\n println(\"Retrying test \" + context.displayName + \", attempt \" + store.get(\"retries\"))\n } else {\n throw throwable\n }\n }\n}"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/SearchPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SearchPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n val search = page.locator(\".navbar input\").and(page.getByPlaceholder(\"Search...\"))\n\n search.fill(\"internet banking system\")\n search.press(\"Enter\")\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Search results | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.and(page.locator(\".is-active\"))).hasCount(0)\n }\n }\n\n @Test\n fun `content renders correctly`() {\n val content = page.locator(\".content > *\").filter(Locator.FilterOptions().setVisible(true))\n\n assertThat(content.nth(0)).containsText(\"Search results\")\n\n val expectedSearchResults = listOf(\n listOf(\"Internet Banking System | Context views\", \"Context views\"),\n listOf(\"E-mail System | Dependencies\", \"Dependencies\"),\n listOf(\"Internet Banking System | Description\", \"Software System Info\"),\n listOf(\"Mainframe Banking System | Dependencies\", \"Dependencies\"),\n listOf(\"Internet Banking System | Component views\", \"Component views\"),\n listOf(\"Internet Banking System | Container views\", \"Container views\"),\n listOf(\"Internet Banking System | Record Internet Banking System architecture decisions\", \"Software System Decision\"),\n listOf(\"ATM | Dependencies\", \"Dependencies\"),\n listOf(\"Mainframe Banking System | Context views\", \"Context views\"),\n listOf(\"Internet Banking System | Dependencies\", \"Dependencies\"),\n listOf(\"E-mail System | Context views\", \"Context views\"),\n listOf(\"Big Bank plc architecture\", \"Home\"),\n listOf(\"Embedding diagrams and images\", \"Workspace Documentation\"),\n )\n\n expectedSearchResults.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(content.nth(1).locator(\"p:not(.mb-0)\").also {\n it.nth(0).waitFor()\n }.nth(rowIndex).locator(\"> *\").nth(colIndex)).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/SoftwareSystemDependenciesPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemDependenciesPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Dependencies\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Dependencies\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n val content = page.locator(\".content > *\")\n\n assertThat(content.nth(0)).containsText(\"Inbound\")\n assertThat(content.nth(2)).containsText(\"Outbound\")\n\n val expectedTableHeadings = listOf(\"System\", \"Description\", \"Technology\")\n\n expectedTableHeadings.forEachIndexed { index, text ->\n assertThat(content.nth(1).locator(\"thead th\").nth(index)).containsText(text)\n }\n expectedTableHeadings.forEachIndexed { index, text ->\n assertThat(content.nth(3).locator(\"thead th\").nth(index)).containsText(text)\n }\n\n val outboundData = listOf(\n listOf(\n \"E-mail System\",\n \"Sends e-mail using\",\n \"\"\n ),\n listOf(\n \"Mainframe Banking System\",\n \"Gets account information from, and makes payments using\",\n \"\"\n )\n )\n\n outboundData.forEachIndexed { rowIndex, data ->\n data.forEachIndexed { cellIndex, text ->\n assertThat(content.nth(3).locator(\"tbody tr\").nth(rowIndex).locator(\"td\").nth(cellIndex)).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/SoftwareSystemHomePageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemHomePageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Info\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n val content = page.locator(\".content > div > *\")\n\n assertThat(content.nth(0)).containsText(\"Description\")\n assertThat(content.nth(2)).containsText(\"Vision\")\n assertThat(content.nth(4)).containsText(\"References\")\n\n assertThat(content.nth(1)).containsText(\"This is our fancy Internet Banking System.\")\n assertThat(content.nth(3)).containsText(\"One system to rule them all!\")\n assertThat(content.nth(5)).containsText(\"Source Code on GitHub: [https://github.com/avisi-cloud/structurizr-site-generatr]\")\n }\n\n @Test\n fun `properties render correctly`() {\n val properties = page.locator(\".content > :not(div)\")\n\n assertThat(properties.nth(0)).containsText(\"Properties\")\n\n val table = properties.and(page.locator(\".table\"))\n val tableHeadings = table.locator(\"thead th\")\n\n assertThat(tableHeadings.nth(0)).containsText(\"Name\")\n assertThat(tableHeadings.nth(1)).containsText(\"Value\")\n\n val expectedPropertyValues = listOf(\n listOf(\n \"Development Team\",\n \"Dev/Internet Services\"\n ),\n listOf(\n \"Owner\",\n \"Customer Services\"\n ),\n listOf(\n \"Url\",\n \"https://en.wikipedia.org/wiki/Online_banking\"\n ),\n )\n\n expectedPropertyValues.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(table.locator(\"tbody tr\").nth(rowIndex).locator(\"td\").nth(colIndex)).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/SoftwareSystemsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Software Systems\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Software Systems | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Software Systems\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n val content = page.locator(\".content > *\")\n\n val title = content.nth(0)\n\n assertThat(title).containsText(\"Software Systems\")\n\n val table = content.and(page.locator(\".table\"))\n\n val tableHeadings = table.locator(\"thead th\")\n\n assertThat(tableHeadings.nth(0)).containsText(\"Name\")\n assertThat(tableHeadings.nth(1)).containsText(\"Description\")\n\n val expectedData = listOf(\n listOf(\n \"Acquirer (External)\",\n \"Facilitates PIN transactions for merchants.\"\n ),\n listOf(\n \"ATM\",\n \"Allows customers to withdraw cash.\"\n ),\n listOf(\n \"E-mail System\",\n \"The internal Microsoft Exchange e-mail system.\"\n ),\n listOf(\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n ),\n listOf(\n \"Mainframe Banking System\",\n \"Stores all of the core banking information about customers, accounts, transactions, etc.\"\n )\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(table.locator(\"tbody tr\").nth(rowIndex).locator(\"td\").nth(colIndex)).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/WorkspaceHomePageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass WorkspaceHomePageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).hasText(\"Home\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n val content = page.locator(\".content > div > *\")\n\n val title = content.nth(0)\n val paragraph1 = content.nth(1)\n val paragraph2 = content.nth(2)\n\n assertThat(title).containsText(\"Big Bank plc architecture\")\n assertThat(paragraph1).containsText(\"This site contains the C4 architecture model for Big Bank plc.\")\n assertThat(paragraph2).containsText(\"This page is the home page, because it is the first file in the workspace-docs directory, when the files are sorted alphabetically.\")\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/DecisionPageTestHelper.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport assertk.assertThat\nimport assertk.assertions.isEqualTo\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.Page\n\nclass DecisionPageTestHelper {\n fun testDecisionContent(page: Page, additionalActions: (List) -> Unit) {\n val content = page.locator(\".content > div > *\")\n\n val title = content.nth(0)\n val date = content.nth(1)\n val status = content.nth(3)\n val context = content.nth(5)\n val decision = content.nth(7)\n val consequences = content.nth(9)\n\n assertThat(content.nth(2).innerText()).isEqualTo(\"Status\")\n assertThat(content.nth(4).innerText()).isEqualTo(\"Context\")\n assertThat(content.nth(6).innerText()).isEqualTo(\"Decision\")\n assertThat(content.nth(8).innerText()).isEqualTo(\"Consequences\")\n\n additionalActions(listOf(\n title,\n date,\n status,\n context,\n decision,\n consequences\n ))\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/DecisionsPageTestHelper.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport assertk.assertThat\nimport assertk.assertions.isEqualTo\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.Page\n\nclass DecisionsPageTestHelper {\n fun testDecisionTabs(page: Page, additionalActions: (Locator) -> Unit) {\n val tabs = page.locator(\".content .tabs:not(.is-size-7) a\")\n\n additionalActions(tabs)\n }\n\n fun testComponentDecisionTabs(page: Page, additionalActions: (Locator) -> Unit) {\n val tabs = page.locator(\".content .tabs.is-size-7 a\")\n\n additionalActions(tabs)\n }\n\n fun testDecisionsTable(page: Page, additionalActions: (List) -> Unit) {\n val tableHeadings = page.locator(\".table thead th\")\n val tableRows = page.locator(\".table tbody tr\")\n\n val locators = tableRows.all().map { row -> row.locator(\"td\") }\n\n assertThat(tableHeadings.count()).isEqualTo(4)\n assertThat(tableHeadings.nth(0).innerText()).isEqualTo(\"ID\")\n assertThat(tableHeadings.nth(1).innerText()).isEqualTo(\"Date\")\n assertThat(tableHeadings.nth(2).innerText()).isEqualTo(\"Status\")\n assertThat(tableHeadings.nth(3).innerText()).isEqualTo(\"Title\")\n\n additionalActions(locators)\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemContainerComponentDecisionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerComponentDecisionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"API Application\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"E-mail Component\")).click()\n page.locator(\".table a\").and(page.getByText(\"Record Email Component architecture decision\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n decisionPageTestHelper.testDecisionContent(page) { locators ->\n val expectedData = listOf(\n \"1. Record Email Component architecture decision\",\n \"Date: 2022-06-21\",\n \"Accepted\",\n \"We need to record the architectural decisions made on this project.\",\n \"We will use Architecture Decision Records, as described by Michael Nygard.\",\n \"See Michael Nygard’s article, linked above. For a lightweight ADR toolset, see Nat Pryce’s adr-tools.\"\n )\n\n expectedData.forEachIndexed { index, text ->\n assertThat(locators[index]).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemContainerComponentDecisionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerComponentDecisionsPageTest : E2ETestFixture() {\n private val decisionPageTestHelper = DecisionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"API Application\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"E-mail Component\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `decision tabs render correctly`() {\n decisionPageTestHelper.testDecisionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(1)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `component decision tabs render correctly`() {\n decisionPageTestHelper.testComponentDecisionTabs(page) { tabs ->\n assertThat(tabs).hasCount(2)\n\n assertThat(tabs.nth(0)).containsText(\"Mainframe Banking System Facade\")\n assertThat(tabs.nth(1)).containsText(\"E-mail Component\")\n\n assertThat(tabs.nth(1)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `decisions table renders correctly`() {\n decisionPageTestHelper.testDecisionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"21-06-2022\", \"Accepted\", \"Record Email Component architecture decision\"),\n listOf(\"2\", \"17-12-2024\", \"Superseded\", \"Implement Feature 1\"),\n listOf(\"3\", \"17-12-2024\", \"Accepted\", \"Another Realisation of Feature 1\"),\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemContainerDecisionPage.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerDecisionPage : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"Database\")).click()\n page.locator(\".table a\").and(page.getByText(\"Using Oracle database schema\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n decisionPageTestHelper.testDecisionContent(page) { locators ->\n val expected = listOf(\n \"4. Using Oracle database schema\",\n \"Date: 2025-11-13\",\n \"Accepted\",\n \"The issue motivating this decision, and any context that influences or constrains the decision.\",\n \"The change that we’re proposing or have agreed to implement.\",\n \"What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.\"\n )\n\n expected.forEachIndexed { index, text ->\n assertThat(locators[index]).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemContainerDecisionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerDecisionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"Database\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `decision tabs render correctly`() {\n decisionPageTestHelper.testDecisionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(2)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `component decision tabs render correctly`() {\n decisionPageTestHelper.testComponentDecisionTabs(page) { tabs ->\n assertThat(tabs).hasCount(1)\n\n assertThat(tabs.nth(0)).containsText(\"Container\")\n\n assertThat(tabs.nth(0)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `decisions table renders correctly`() {\n decisionPageTestHelper.testDecisionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"4\", \"13-11-2025\", \"Accepted\", \"Using Oracle database schema\")\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemDecisionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemDecisionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".table a\").and(page.getByText(\"Record Internet Banking System architecture decisions\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n decisionPageTestHelper.testDecisionContent(page) { locators ->\n val expectedData = listOf(\n \"1. Record Internet Banking System architecture decisions\",\n \"Date: 2022-06-21\",\n \"Accepted\",\n \"We need to record the architectural decisions made on this project.\",\n \"We will use Architecture Decision Records, as described by Michael Nygard.\",\n \"See Michael Nygard’s article, linked above. For a lightweight ADR toolset, see Nat Pryce’s adr-tools.\"\n )\n\n expectedData.forEachIndexed { index, text ->\n assertThat(locators[index]).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/SoftwareSystemDecisionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemDecisionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Decisions\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `decision tabs render correctly`() {\n decisionPageTestHelper.testDecisionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(0)).containsClass(\"is-active\")\n }\n }\n\n @Test\n fun `component decision tabs render correctly`() {\n decisionPageTestHelper.testComponentDecisionTabs(page) { locators ->\n assertThat(locators).hasCount(0)\n }\n }\n\n @Test\n fun `decisions table renders correctly`() {\n decisionPageTestHelper.testDecisionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"21-06-2022\", \"Accepted\", \"Record Internet Banking System architecture decisions\")\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/WorkspaceDecisionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass WorkspaceDecisionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionPageTestHelper = DecisionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Decisions\")).click()\n page.locator(\".content a\").and(page.getByText(\"Record architecture decisions\")).click()\n }\n\n @Test\n fun `title is correct`() {\n page.onDOMContentLoaded {\n assertThat(page).hasTitle(\"Record architecture decisions | Big Bank plc\")\n }\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n decisionPageTestHelper.testDecisionContent(page) { locators ->\n val expectedData = listOf(\n \"1. Record architecture decisions\",\n \"Date: 2022-06-21\",\n \"Accepted\",\n \"We need to record the architectural decisions made on this project.\",\n \"We will use Architecture Decision Records, as described by Michael Nygard.\",\n \"See Michael Nygard’s article, linked above. For a lightweight ADR toolset, see Nat Pryce’s adr-tools.\"\n )\n\n expectedData.forEachIndexed { index, text ->\n assertThat(locators[index]).containsText(text)\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/decisions/WorkspaceDecisionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.decisions\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass WorkspaceDecisionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val decisionsPageTestHelper = DecisionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Decisions\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Decisions | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Decisions\")\n }\n }\n\n @Test\n fun `decisions table renders correctly`() {\n decisionsPageTestHelper.testDecisionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"21-06-2022\", \"Accepted\", \"Record architecture decisions\"),\n listOf(\"2\", \"17-12-2024\", \"Superseded\", \"Implement Feature 1\"),\n listOf(\"3\", \"17-12-2024\", \"Accepted\", \"Another Realisation of Feature 1\"),\n listOf(\"4\", \"13-11-2025\", \"Accepted\", \"Using Oracle database schema\"),\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SectionPageTestHelper.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.Page\n\nclass SectionPageTestHelper {\n fun testSectionContent(page: Page, additionalActions: (List) -> Unit) {\n val content = page.locator(\".content > div > *\")\n\n val title = content.nth(0)\n val notes = content.nth(1)\n\n additionalActions(listOf(\n title,\n notes\n ))\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SectionsPageTestHelper.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.Locator\nimport com.microsoft.playwright.Page\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\n\nclass SectionsPageTestHelper {\n fun testSectionTabs(page: Page, additionalActions: (Locator) -> Unit) {\n val tabs = page.locator(\".content .tabs:not(.is-size-7) a\")\n\n additionalActions(tabs)\n }\n\n fun testComponentSectionTabs(page: Page, additionalActions: (Locator) -> Unit) {\n val tabs = page.locator(\".content .tabs.is-size-7 a\")\n\n additionalActions(tabs)\n }\n\n fun testSectionsTable(page: Page, additionalActions: (List) -> Unit) {\n val tableHeadings = page.locator(\".table thead th\")\n val tableRows = page.locator(\".table tbody tr\")\n\n val locators = tableRows.all().map { row -> row.locator(\"td\") }\n\n assertThat(tableHeadings).hasCount(2)\n\n assertThat(tableHeadings.nth(0)).containsText(\"#\")\n assertThat(tableHeadings.nth(1)).containsText(\"Title\")\n\n additionalActions(locators)\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemContainerComponentSectionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerComponentSectionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionPageTestHelper = SectionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"API Application\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"E-mail Component\")).click()\n page.locator(\".table a\").and(page.getByText(\"Email Component inner workings\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `sections table renders correctly`() {\n sectionPageTestHelper.testSectionContent(page) { locators ->\n assertThat(locators[0]).containsText(\"Email Component inner workings\")\n assertThat(locators[1]).containsText(\"This is how the e-mail component works.\")\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemContainerComponentSectionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerComponentSectionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionsPageTestHelper = SectionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"API Application\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"E-mail Component\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `section tabs render correctly`() {\n sectionsPageTestHelper.testSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(1)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `component section tabs render correctly`() {\n sectionsPageTestHelper.testComponentSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(2)\n\n assertThat(tabs.nth(0)).containsText(\"Mainframe Banking System Facade\")\n assertThat(tabs.nth(1)).containsText(\"E-mail Component\")\n\n assertThat(tabs.nth(1)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `sections table renders correctly`() {\n sectionsPageTestHelper.testSectionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"Email Component inner workings\")\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemContainerSectionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerSectionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionPageTestHelper = SectionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"Database\")).click()\n page.locator(\".table a\").and(page.getByText(\"Usage\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `sections table renders correctly`() {\n sectionPageTestHelper.testSectionContent(page) { locators ->\n assertThat(locators[0]).containsText(\"Usage\")\n assertThat(locators[1]).containsText(\"This is how we use this thing.\")\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemContainerSectionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemContainerSectionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionsPageTestHelper = SectionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n page.locator(\".content > .tabs a\").and(page.getByText(\"Database\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `section tabs render correctly`() {\n sectionsPageTestHelper.testSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(2)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `component section tabs render correctly`() {\n sectionsPageTestHelper.testComponentSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(1)\n\n assertThat(tabs.nth(0)).containsText(\"Container\")\n\n assertThat(tabs.nth(0)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `sections table renders correctly`() {\n sectionsPageTestHelper.testSectionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"Usage\")\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemSectionPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemSectionPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionPageTestHelper = SectionPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n page.locator(\".table a\").and(page.getByText(\"History\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `content renders correctly`() {\n sectionPageTestHelper.testSectionContent(page) { locators ->\n assertThat(locators[0]).containsText(\"History\")\n assertThat(locators[1]).containsText(\"Some notes how we got to the current state.\")\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/e2e/sections/SoftwareSystemSectionsPageTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.e2e.sections\n\nimport com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat\nimport nl.avisi.structurizr.site.generatr.site.e2e.E2ETestFixture\nimport nl.avisi.structurizr.site.generatr.site.e2e.PageTestHelper\nimport org.junit.jupiter.api.BeforeEach\nimport org.junit.jupiter.api.Order\nimport kotlin.test.Test\n\nclass SoftwareSystemSectionsPageTest : E2ETestFixture() {\n private val pageTestHelper = PageTestHelper()\n private val sectionsPageTestHelper = SectionsPageTestHelper()\n\n @BeforeEach\n @Order(2)\n fun `navigate to page`() {\n page.navigate(SITE_URL)\n\n page.locator(\".menu a\").and(page.getByText(\"Internet Banking System\")).click()\n page.locator(\".container > .tabs a\").and(page.getByText(\"Documentation\")).click()\n }\n\n @Test\n fun `title is correct`() {\n assertThat(page).hasTitle(\"Internet Banking System | Big Bank plc\")\n }\n\n @Test\n fun `menu renders correctly`() {\n pageTestHelper.testMenu(page) { menu ->\n assertThat(menu.locator(\".is-active\")).containsText(\"Internet Banking System\")\n }\n }\n\n @Test\n fun `title and subtitle render correctly`() {\n pageTestHelper.testTitleAndSubtitle(\n page,\n \"Internet Banking System\",\n \"Allows customers to view information about their bank accounts, and make payments.\"\n )\n }\n\n @Test\n fun `tabs render correctly`() {\n pageTestHelper.testTabs(page) { tabs ->\n assertThat(tabs.and(page.locator(\".is-active\"))).containsText(\"Documentation\")\n }\n }\n\n @Test\n fun `section tabs render correctly`() {\n sectionsPageTestHelper.testSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(3)\n\n assertThat(tabs.nth(0)).containsText(\"System\")\n assertThat(tabs.nth(1)).containsText(\"API Application\")\n assertThat(tabs.nth(2)).containsText(\"Database\")\n\n assertThat(tabs.nth(0)).hasClass(\"is-active\")\n }\n }\n\n @Test\n fun `component section tabs render correctly`() {\n sectionsPageTestHelper.testComponentSectionTabs(page) { tabs ->\n assertThat(tabs).hasCount(0)\n }\n }\n\n @Test\n fun `sections table renders correctly`() {\n sectionsPageTestHelper.testSectionsTable(page) { locators ->\n val expectedData = listOf(\n listOf(\"1\", \"History\"),\n listOf(\"2\", \"Usage\"),\n )\n\n expectedData.forEachIndexed { rowIndex, row ->\n row.forEachIndexed { colIndex, text ->\n assertThat(locators[rowIndex].nth(colIndex)).containsText(text)\n }\n }\n }\n }\n}\n"
},
{
"path": "src/test/kotlin/nl/avisi/structurizr/site/generatr/site/model/AsciidocToHtmlTest.kt",
"content": "package nl.avisi.structurizr.site.generatr.site.model\n\nimport assertk.assertThat\nimport assertk.assertions.isEqualTo\nimport assertk.assertions.matches\nimport com.structurizr.documentation.Format\nimport org.junit.jupiter.api.Test\n\nclass AsciidocToHtmlTest : ViewModelTest() {\n\n @Test\n fun `translates asciidoc`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(\n viewModel,\n \"\"\"\n == header\n content\n \"\"\".trimIndent(),\n Format.AsciiDoc,\n svgFactory\n )\n\n assertThat(html).isEqualTo(\n \"\"\"\n
\n
header
\n
\n
\n
content
\n
\n
\n
\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `translates asciidoc table`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(\n viewModel,\n \"\"\"\n == header\n\n |===\n |header1 |header2\n\n |content\n |content\n |===\n \"\"\".trimIndent(),\n Format.AsciiDoc,\n svgFactory\n )\n\n assertThat(html).isEqualTo(\n \"\"\"\n
\n
header
\n
\n
\n
\n
\n
\n
\n \n
\n
header1
\n
header2
\n
\n \n \n
\n
\n
content
\n
\n
\n
content
\n
\n
\n \n
\n
\n
\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `translates asciidoc admonition block`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(\n viewModel,\n \"\"\"\n == header\n\n NOTE: This is a note.\n \"\"\".trimIndent(),\n Format.AsciiDoc,\n svgFactory\n )\n\n assertThat(html).isEqualTo(\n \"\"\"\n
\n
header
\n
\n
\n
\n \n
\n
\n
Note
\n
\n
This is a note.
\n
\n \n
\n
\n
\n
\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `renders PlantUML code to SVG`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(\n viewModel,\n \"\"\"\n [plantuml]\n ----\n @startuml\n class Foo\n @enduml\n ----\n \"\"\".trimIndent(),\n Format.AsciiDoc,\n svgFactory\n )\n\n assertThat(html).matches(\"
.*.*
\".toRegex(RegexOption.DOT_MATCHES_ALL))\n }\n\n @Test\n fun `translates mermaid graphings in asciidoc`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(\n viewModel,\n \"\"\"\n == Mermaid\n\n [source, mermaid]\n ----\n graph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n ----\n \"\"\".trimIndent(),\n Format.AsciiDoc,\n svgFactory\n )\n\n assertThat(html).isEqualTo(\n \"\"\"\n
\n
Mermaid
\n
\n
\n
\n
graph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;
\n
\n
\n
\n
\n \"\"\".trimIndent()\n )\n }\n\n @Test\n fun `embedded diagram`() {\n val generatorContext = generatorContext()\n val viewModel = HomePageViewModel(generatorContext)\n\n val html = toHtml(viewModel, \"image::embed:SystemLandscape[System Landscape Diagram]\", Format.AsciiDoc, svgFactory)\n\n assertThat(html).isEqualTo(\n \"\"\"\n