Add docs

.dockerignore

@@ -1,21 +1,25 @@
 .editorconfig
 .git
+.gitignore
 .github
 sonar-project.properties
-AUTHORS.md
-CONTRIBUTING.md
+*.md
 LICENSE
 Makefile
 NOTICE
-README.md
 arm/
 powerpc/
 mips/
 .golangci.yml
-_temp
 .vscode
-node1
-node2
-node3
-.gitignore
-changelog.md
+go.work
+go.work.sum
+tools/
+test_e2e/
+!test_e2e/test_api.go
+!test_e2e/go.mod
+!test_e2e/go.sum
+mocks/
+docker/
+**/*_test.go
+docs/

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,33 +2,38 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: Bug
+labels: bug
 ---
 
-**Describe the bug**
+## Describe the bug
 
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+## To Reproduce
 
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+## Expected behavior
 
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+## Screenshots
 
 If applicable, add screenshots to help explain your problem.
 
-**Application (please complete the following information):**
+## Application
+
+Please complete the following information:
 
 - badaas version [X.X.X] or commit hash
+- go version
+- database vendor and version (in case of bugs related with badaas-orm)
 
-**Additional context**
+## Additional context
 
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,7 @@
+---
+name: Discussion
+about: Start a discussion for BaDaaS
+title: ''
+labels: question
+---
+<!-- Please join the DitRit discord server https://discord.gg/zkKfj9gj2C to ask questions and troubleshoot (use the BADAAS channel). For all other design discussions please continue. -->

.github/ISSUE_TEMPLATE/user_story.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: User Story, To be verify
+labels: enhancement
 ---
 
 ## Description
@@ -26,7 +26,7 @@ labels: User Story, To be verify
 
 `[Put all others constraints here, like list of acceptances values or other]`
 
-## Resources:
+## Resources
 
 `[Put all your resources here, like mockups, diagrams or other here]`
 
@@ -37,4 +37,3 @@ labels: User Story, To be verify
 ## Links
 
 `[Only use by the team, to link this feature with epic, technical tasks or bugs]`
-

.github/pull_request_template.md

@@ -1,5 +1,5 @@
 :information_source:  Don't forget to modify the changelog.md before merging this branch.
 
 :information_source:  Don't forget to modify config files:
--  `badaas.example.yml`: the example file.
--  `/scripts/e2e/api/ci-conf.yml`: otherwise you will probably break the CI. (*For local testing please use [act](https://github.com/nektos/act)*).
+
+- `badaas.example.yml`: the example file.

.github/workflows/CI.yml

@@ -5,6 +5,7 @@ on:
       - main
   pull_request:
     types: [opened, synchronize, reopened]
+
 jobs:
   branch-naming-rules:
     name: Check branch name
@@ -18,6 +19,35 @@ jobs:
           min_length: 5
           max_length: 50
 
+  check-style:
+    name: Code style
+    needs: [branch-naming-rules]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.18'
+          cache: true
+      - name: badaas lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.53.3
+          skip-cache: true
+          skip-pkg-cache: true
+          skip-build-cache: true
+      - name: teste2e lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.53.3
+          working-directory: test_e2e
+          args: --config=../.golangci.yml
+          skip-cache: true
+          skip-pkg-cache: true
+          skip-build-cache: true
+
   unit-tests:
     name: Unit tests
     needs: [branch-naming-rules]
@@ -30,16 +60,25 @@ jobs:
         with:
           go-version: '^1.18'
           cache: true
-      - name: Run test
-        run:  go test $(go list ./... | sed 1d) -coverprofile=coverage.out -v
+      - name: Install gotestsum
+        run: go install gotest.tools/gotestsum@latest
+      - name: Run unit tests
+        run: gotestsum --junitfile unit-tests.xml $(go list ./... | grep -v testintegration) -coverpkg=./... -coverprofile=coverage_unit.out
       - uses: actions/upload-artifact@v3
         with:
           name: coverage
-          path: coverage.out
+          path: coverage_unit.out
+      - name: Test Report
+        uses: dorny/test-reporter@v1
+        if: always() # run this step even if previous steps failed
+        with:
+          name: Unit Tests Report  # Name of the check run which will be created
+          path: unit-tests.xml     # Path to test results
+          reporter: java-junit     # Format of test results
 
-  check-style:
-    name: Code style
-    needs: [branch-naming-rules]
+  integration-tests:
+    name: Integration tests
+    needs: [unit-tests]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -49,14 +88,25 @@ jobs:
         with:
           go-version: '^1.18'
           cache: true
-
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+      - name: Install gotestsum
+        run: go install gotest.tools/gotestsum@latest
+      - name: Start containers
+        run: docker compose -f "docker/test_db/docker-compose.yml" up -d
+      - name: Run test
+        run:  gotestsum --junitfile integration-tests.xml ./testintegration -coverpkg=./... -coverprofile=coverage_int.out
+      - name: Test Report
+        uses: dorny/test-reporter@v1
+        if: always() # run this step even if previous steps failed
         with:
-          version: latest
-          skip-cache: true
-          skip-pkg-cache: true
-          skip-build-cache: true
+          name: Integration Tests Report  # Name of the check run which will be created
+          path: integration-tests.xml     # Path to test results
+          reporter: java-junit            # Format of test results
+      - uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: coverage_int.out
+      - name: Stop containers
+        run: docker stop badaas-test-db
 
   e2e-tests:
     name: E2E Tests
@@ -71,41 +121,39 @@ jobs:
           go-version: '^1.18'
           cache: true
       - name: Start containers
-        run: docker compose -f "scripts/e2e/docker-compose.yml" up -d --build
+        run: docker compose -f "docker/test_db/docker-compose.yml" -f "docker/test_api/docker-compose.yml" up -d --build
       - name: Wait for API server to be up
         uses: mydea/action-wait-for-api@v1
         with:
           url: "http://localhost:8000/info"
-          timeout: 20
+          timeout: 60
       - name: Run test
-        run:  go test -v
+        run:  go test ./test_e2e -v
       - name: Get logs 
         if: always()
-        run: docker compose -f "scripts/e2e/docker-compose.yml" logs --no-color 2>&1 | tee app.log &
+        run: docker compose -f "docker/test_db/docker-compose.yml" -f "docker/test_api/docker-compose.yml" logs --no-color 2>&1 | tee app.log &
       - name: Stop containers
         if: always()
-        run: docker compose -f "scripts/e2e/docker-compose.yml" down
+        run: docker compose -f "docker/test_db/docker-compose.yml" -f "docker/test_api/docker-compose.yml" down
       - uses: actions/upload-artifact@v3
         with:
           name: docker-compose-e2e-logs
           path: app.log
-      
+
   sonarcloud:
     name: SonarCloud
-    needs: [unit-tests, check-style]
+    needs: [check-style, integration-tests]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Download line coverage report
+      - name: Download line coverage reports
         uses: actions/download-artifact@v3
         with:
           name: coverage
-          path: coverage.out
       - name: SonarCloud Scan
         uses: sonarsource/sonarcloud-github-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -13,21 +13,23 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+*-tests*.xml
 
 # Dependency directories (remove the comment below to include it)
-# vendor/
+vendor/
 
 # Go workspace file
-go.work
+# go.work
 
 # cockroach files
 node*
 
-#Vscode conf
+# vscode conf
 .vscode
 
 # binary output
 badaas
+!docs/badaas
 
-# temporary directories
-_temp
+# Sphinx documentation
+docs/_build/