Feature/move leva doc

.github/workflows/build-workflow.yml

@@ -0,0 +1,27 @@
+name: Build and test
+
+on: [ push ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      # TODO https://github.com/opendevstack/ods-quickstarters/issues/766
+      image: s2obcn/jdk-11_openj9-wkhtmltopdf-ubi:main
+      env:
+        WKHTML_TO_PDF_WITH_DOCKER: false
+      volumes:
+        - /var/run/docker.sock:/var/run/docker.sock
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Build with Gradle
+        run: ./gradlew clean test --stacktrace --no-daemon
+
+      - name: TestReport
+        uses: actions/upload-artifact@v3
+        if: ${{ always() }}
+        with:
+          name: JUnit Report
+          path: build/reports/**/**

.github/workflows/changelog-enforcer.yml

@@ -8,7 +8,7 @@ jobs:
   changelog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: dangoslen/changelog-enforcer@v2
         with:
           changeLogPath: 'CHANGELOG.md'

.github/workflows/e2e-tests-workflow.yml

@@ -0,0 +1,36 @@
+name: e2e and performance Test
+
+on: [ pull_request ]
+
+jobs:
+  e2eTest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Docker test
+        run: ./gradlew dockerTest --stacktrace --no-daemon
+
+      - name: TestReport
+        uses: actions/upload-artifact@v3
+        if: ${{ always() }}
+        with:
+          name: JUnit e2e Report
+          path: build/reports/**/**
+
+  performanceTest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Performance test
+        run: ./gradlew gatlingRun --stacktrace --no-daemon
+
+      - name: TestReport
+        uses: actions/upload-artifact@v3
+        if: ${{ always() }}
+        with:
+          name: JUnit performance test Report
+          path: build/reports/**/**

CHANGELOG.md

@@ -1,19 +1,31 @@
 # Changelog
 
+- Temporal change with add LevaDoc 3.
+
+
 ## Unreleased
 - Fix TIR and DTR documents are not properly indexed ([#55](https://github.com/opendevstack/ods-document-generation-svc/pull/55))
 - Fix wkhtmltox hangs ([#66](https://github.com/opendevstack/ods-document-generation-svc/pull/66))
 - Improve memory management and error handling ([#70](https://github.com/opendevstack/ods-document-generation-svc/pull/70))
-- ODS AMI build failing due to broken x11 fonts package installation ([#74](https://github.com/opendevstack/ods-document-generation-svc/pull/74))
+- Use Markdown Architectural Decision Records https://adr.github.io/madr/
+- Improve maintainability by adding SpringBoot framework
+- Added IT (Docker tests)
+- Added performance tests
+- logback.xml can be overridden from command line
+- removed unused params from payloads.
+- removed param jekins to jenkins
+- Removed byte[] use
+- Set test summary for empty description in TCR ([#837](https://github.com/opendevstack/ods-jenkins-shared-library/pull/837))
+- Set test summary for empty description in TCR for acceptance tests ([#837](https://github.com/opendevstack/ods-jenkins-shared-library/pull/844))
+
+## [4.0] - 2021-18-11
+=======
+### Added
+- Added log to print /document endpoint input
 
 ### Fixed
 - Github template tests fail in proxy environment ([#56](https://github.com/opendevstack/ods-document-generation-svc/issues/56))
-- 
-
-## [4.0] - 2021-15-11
-
-### Added
-- Added log to print /document endpoint input
+- Fix TIR and DTR documents are not properly indexed ([#55](https://github.com/opendevstack/ods-document-generation-svc/pull/55))
 
 ### Changed
 - Updated maxRequestSize value from 100m to 200m

README.md

@@ -2,44 +2,61 @@
 
 # ODS Document Generation Service
 
-A document generation service that transforms document templates in a remote Bitbucket repository into PDF documents.
+A document generation service that:
+- Transforms document templates in a remote Bitbucket repository into PDF documents.
+- Generate LeVA documentation and uploads them to a Nexus service
 
 ## Distribute
+In order to generate a distributed app a Docker client needs to be configured.
+- The _gradle_ task: __dockerBuildImage__ generates a Docker image with the application
+
+### Environment
+The file src/main/resources/application.yml has the properties and parameters that the app admit.
+
+## Unit Tests
+In order to execute the tests a Docker client needs to be configured.
 
 ```
-make shadowJar
+gradle test
 ```
 
-## Run
+## Integration Tests
+In order to execute the tests a Docker client needs to be configured.
 
 ```
-make run
+gradle dockerTest
 ```
 
-## Test
+## Performance Tests
+In order to execute the tests a Docker client needs to be configured.
 
 ```
-make test
+gradle gatlingRun
 ```
 
 ## Document Templates
-
 When processing a template `type` at a specific `version`, and data into a document, the DocGen service expects the BitBucket repository to have a `release/${version}` branch that contains the template type at `/templates/${type}.html.tmpl`.
 
-## Requirements
+## LeVA Doc generation
+When generating LeVA documentation, the app expects the xml tests results and the Jenkins Logs to be in a Nexus service.
 
-### Packages
+## Structure package
+Main groovy code in src/main/groovy:
+- org.ods.doc.gen.core:  common 'utilities'
+- org.ods.doc.gen.adapters: clients to other systems. They translate the interfaces of external systems to the interfaces required.
+- org.ods.doc.gen.doc: LeVA document generation functional module
+- org.ods.doc.pdf.builder: PDF generation document functional module
 
-- [wkhtmltopdf](https://wkhtmltopdf.org/)
 
-### Environment
+## History
+The module __"leva.doc"__ is a refactor extracted from the LevaDoc functionality of the [shared-library](https://github.com/opendevstack/ods-jenkins-shared-library).
+You can see the shared-library before the refactor here: https://github.com/opendevstack/ods-jenkins-shared-library/tree/feature/beforeMoveLevaDoc
 
-- `BITBUCKET_URL`
-- `BITBUCKET_USERNAME`
-- `BITBUCKET_PASSWORD`
-- `BITBUCKET_DOCUMENT_TEMPLATES_PROJECT`
-- `BITBUCKET_DOCUMENT_TEMPLATES_REPO`
+Some correspondences between the shared-lib classes and this project:
+- org.ods.orchestration.util.Project => org.ods.doc.gen.project.data.ProjectData
+- org.ods.orchestration.usecase.LeVADocumentUseCase => org.ods.doc.gen.leva.doc.services.LeVADocumentService
+- org.ods.orchestration.usecase.DocGenUseCase => org.ods.doc.gen.leva.doc.services.DocGenService
+- org.ods.orchestration.util.DocumentHistory => org.ods.doc.gen.leva.doc.services.DocumentHistory
+- org.ods.orchestration.usecase.PDFUtil => org.ods.doc.gen.leva.doc.services.PDFService
 
-## Reference
 
-This project is based on https://github.com/jooby-project/gradle-starter.