update docs and developers utils

ditrit · Aug 1, 2023 · f523952 · f523952
1 parent f1bed03
commit f523952
Show file tree

Hide file tree

Showing 17 changed files with 276 additions and 290 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,21 +1,24 @@
 .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
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -5,30 +5,33 @@ title: ''
 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
 
-**Additional context**
+## Additional context
 
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md
@@ -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]`
-
diff --git a/.github/pull_request_template.md b/.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.
diff --git a/.github/workflows/CI.yml b/.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,8 +19,8 @@ jobs:
           min_length: 5
           max_length: 50
 
-  unit-tests:
-    name: Unit tests
+  check-style:
+    name: Code style
     needs: [branch-naming-rules]
     runs-on: ubuntu-latest
     steps:
@@ -30,15 +31,16 @@ jobs:
         with:
           go-version: '^1.18'
           cache: true
-      - name: Run test
-        run:  go test $(go list ./... | sed 1d) -coverprofile=coverage.out -v
-      - uses: actions/upload-artifact@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
         with:
-          name: coverage
-          path: coverage.out
+          version: v1.52.2
+          skip-cache: true
+          skip-pkg-cache: true
+          skip-build-cache: true
 
-  check-style:
-    name: Code style
+  unit-tests:
+    name: Unit tests
     needs: [branch-naming-rules]
     runs-on: ubuntu-latest
     steps:
@@ -49,14 +51,12 @@ jobs:
         with:
           go-version: '^1.18'
           cache: true
-
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+      - name: Run unit tests
+        run:  go test ./... -coverprofile=coverage_unit.out -v
+      - uses: actions/upload-artifact@v3
         with:
-          version: latest
-          skip-cache: true
-          skip-pkg-cache: true
-          skip-build-cache: true
+          name: coverage_unit
+          path: coverage_unit.out
 
   e2e-tests:
     name: E2E Tests
@@ -71,25 +71,25 @@ 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]
@@ -98,14 +98,13 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - name: Download line coverage report
+      - name: Download unit tests line coverage report
         uses: actions/download-artifact@v3
         with:
-          name: coverage
-          path: coverage.out
+          name: coverage_unit
+          path: coverage_unit.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 }}
diff --git a/.gitignore b/.gitignore
@@ -15,19 +15,16 @@
 *.out
 
 # Dependency directories (remove the comment below to include it)
-# vendor/
+vendor/
 
 # Go workspace file
 # go.work
 
 # cockroach files
 node*
 
-#Vscode conf
+# vscode conf
 .vscode
 
 # binary output
-badaas
-
-# temporary directories
-_temp
+badaas
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,12 +14,12 @@
 
 ### Unit tests
 
-We use the standard test suite in combination with [github.com/stretchr/testify](https://github.com/stretchr/testify) to do our unit testing. Mocks are generated using [mockery](https://github.com/vektra/mockery) a mock generator using this command `mockery --all --keeptree`.
+We use the standard test suite in combination with [github.com/stretchr/testify](https://github.com/stretchr/testify) to do our unit testing. Mocks are generated using [mockery](https://github.com/vektra/mockery) a mock generator using this command `make test_generate_mocks`.
 
 To run them, please run:
 
 ```sh
-go test $(go list ./... | sed 1d) -v
+make test_unit
 ```
 
 ### Feature tests (of end to end tests)
@@ -29,75 +29,64 @@ We use docker to run a Badaas instance in combination with one node of Cockroach
 Run:
 
 ```sh
-docker compose -f "scripts/e2e/docker-compose.yml" up -d --build
+make test_e2e
 ```
 
-Then in an another shell:
-
-```sh
-go test -v
-```
-
-The feature files can be found in the `feature` folder.
+The feature files can be found in the `test_e2e/features` folder.
 
 ## Logger
 
-We use ubber's [zap](https://pkg.go.dev/go.uber.org/zap) to log stuff, please take `zap.Logger` as an argument for your services constructors. [fx](https://github.com/uber-go/fx) will provide your service with an instance.
+We use uber's [zap](https://pkg.go.dev/go.uber.org/zap) to log stuff, please take `zap.Logger` as an argument for your services constructors. [fx](https://github.com/uber-go/fx) will provide your service with an instance.
 
 ## Directory structure
 
 This is the directory structure we use for the project:
 
-- `commands/` *(Go code)*: Contains all the CLI commands. This package relies heavily on github.com/ditrit/verdeter.
-- `configuration/` *(Go code)*: Contains all the configuration holders. Please only use the interfaces, they are all mocked for easy testing
+- `configuration/` *(Go code)*: Contains all the configuration keys and holders. Please only use the interfaces, they are all mocked for easy testing.
 - `controllers/` *(Go code)*: Contains all the http controllers, they handle http requests and consume services.
-- `docs/`: Contains the documentation.
-- `features/`: Contains all the feature tests (or end to end tests).
+- `docker/` : Contains the docker, docker-compose file and configuration files for different environments.
+  - `test_db/` : Contains the Dockerfile to build a development/test version of CockroachDB.
+  - `test_api/` : Contains files to build a development/test version of the api.
+- `test_e2e/`: Contains all the feature and steps for e2e tests.
 - `logger/` *(Go code)*: Contains the logger creation logic. Please don't call it from your own services and code, use the dependency injection system.
-- `persistance/` *(Go code)*: 
-  - `/gormdatabase/` *(Go code)*: Contains the logic to create a <https://gorm.io> database. Also contains a go package named `gormzap`: it is a compatibility layer between *gorm.io/gorm* and *github.com/uber-go/zap*.
-  - `/models/` *(Go code)*: Contains the models. (For a structure to me considered a valid model, it has to embed `models.BaseModel` and satisfy the `models.Tabler` interface. This interface returns the name of the sql table.)
-    - `/dto/` *(Go code)*: Contains the Data Transfert Objects. They are used mainly to decode json payloads.
-  - `/pagination/` *(Go code)*: Contains the pagination logic.
-  - `/repository/` *(Go code)*: Contains the repository interface and implementation. Use uint as ID when using gorm models.
-- `resources/` *(Go code)*: Contains the resources shared with the rest of the codebase (ex: API version).
+- `persistance/` *(Go code)*:
+  - `gormdatabase/` *(Go code)*: Contains the logic to create a <https://gorm.io> database. Also contains a go package named `gormzap`: it is a compatibility layer between *gorm.io/gorm* and *github.com/uber-go/zap*.
+  - `models/` *(Go code)*: Contains the models. (For a structure to me considered a valid model, it has to embed `models.BaseModel` and satisfy the `models.Tabler` interface. This interface returns the name of the sql table.).
+    - `dto/` *(Go code)*: Contains the Data Transfer Objects. They are used mainly to decode json payloads.
+  - `pagination/` *(Go code)*: Contains the pagination logic.
+  - `repository/` *(Go code)*: Contains the repository interfaces and implementations to manage queries to the database.
 - `router/` *(Go code)*: Contains http router of badaas.
-  - `/middlewares/` *(Go code)*: Contains the various http middlewares that we use.
-- `scripts/e2e/` : Contains the docker-compose file for end-to-end test.
-  - `/api/` : Contains the Dockerfile to build badaas with a dedicated config file.
-  - `/db/` : Contains the Dockerfile to build a developpement version of CockroachDB.
-- `services/` *(Go code)*: Contains the Dockerfile to build a developpement version of CockroachDB.
-  - `/auth/protocols/`: Contains the implementations of authentication clients for differents protocols. 
-    - `/basicauth/` *(Go code)*: Handle the authentication using email/password.
-    - `/oidc/` *(Go code)*: Handle the authentication via Open-ID Connect.
-  - `/sessionservice/` *(Go code)*: Handle sessions and their lifecycle.
-  - `/userservice/` *(Go code)*: Handle users.
-  - `validators/` *(Go code)*: Contains validators such as an email validator.
+  - `middlewares/` *(Go code)*: Contains the various http middlewares that we use.
+- `services/` *(Go code)*: Contains services.
+  - `auth/protocols/`: Contains the implementations of authentication clients for different protocols.
+    - `basicauth/` *(Go code)*: Handle the authentication using email/password.
+  - `sessionservice/` *(Go code)*: Handle sessions and their lifecycle.
+  - `userservice/` *(Go code)*: Handle users.
+- `utils/` *(Go code)*: Contains utility functions that can be used all around the project.
+- `validators/` *(Go code)*: Contains validators such as an email validator.
 
 At the root of the project, you will find:
 
 - The README.
 - The changelog.
-- The files for the E2E test http support.
-- The LICENCE file.
+- The LICENSE file.
 
 ## Git
 
 ### Branch naming policy
 
 `[BRANCH_TYPE]/[BRANCH_NAME]`
 
-- `BRANCH_TYPE` is a prefix to describe the purpose of the branch. 
-
+- `BRANCH_TYPE` is a prefix to describe the purpose of the branch.
   Accepted prefixes are:
   - `feature`, used for feature development
   - `bugfix`, used for bug fix
-  - `improvement`, used for refacto
+  - `improvement`, used for refactor
   - `library`, used for updating library
   - `prerelease`, used for preparing the branch for the release
   - `release`, used for releasing project
   - `hotfix`, used for applying a hotfix on main
-  - `poc`, used for proof of concept 
+  - `poc`, used for proof of concept
 - `BRANCH_NAME` is managed by this regex: `[a-z0-9._-]` (`_` is used as space character).
 
 ### Default branch
@@ -113,9 +102,9 @@ We use [Semantic Versioning](https://semver.org/spec/v2.0.0.html) as guideline f
 Steps to release:
 
 - Create a new branch labeled `release/vX.Y.Z` from the latest `main`.
-- Improve the version number in `changelog.md` and `resources/api.go`.
+- Improve the version number in `changelog.md`.
 - Verify the content of the `changelog.md`.
 - Commit the modifications with the label `Release version X.Y.Z`.
 - Create a pull request on github for this branch into `main`.
-- Once the pull request validated and merged, tag the `main` branch with `vX.Y.Z`
-- After the tag is pushed, make the release on the tag in GitHub
+- Once the pull request validated and merged, tag the `main` branch with `vX.Y.Z`.
+- After the tag is pushed, make the release on the tag in GitHub.
diff --git a/Dockerfile b/Dockerfile
diff --git a/Makefile b/Makefile
@@ -0,0 +1,16 @@
+lint:
+	golangci-lint run
+
+test_unit:
+	go test ./... -v
+
+test_e2e:
+	docker compose -f "docker/test_db/docker-compose.yml" -f "docker/test_api/docker-compose.yml" up -d
+	./docker/wait_for_api.sh 8000/info
+	go test ./test_e2e -v
+
+test_generate_mocks:
+	mockery --all --keeptree
+
+.PHONY: test_unit test_e2e
+