Skip to content

Commit

Permalink
Add typical development steps
Browse files Browse the repository at this point in the history
Credit: Kit
  • Loading branch information
bbondy committed Nov 5, 2024
1 parent 8dc2b41 commit 8aca674
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions services/skus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@

4. SKUs API will be available at localhost:3333


### Development cycle

1. Optionally once the steps are complete run `export TEST_TAGS=integration; make docker-test` to make sure everything builds and all the tests pass

2. Write code and run unit tests locally, no need to bring up the environment for example, to run a unit test in SKUs navigate to the skus directory and run `go test -run TestService_uniqBatchesTxTime`

3. Write integration tests then bring up environment using `make docker-dev` at the command prompt run the specific test you have written for example,

> cd services && export GODEBUG=x509ignoreCN=0; go test -count=1 -tags integration -timeout 1m -v -run ControllersTestSuite/TestWebhook_Radom ./skus/...
4. Optionally before pushing code for review run `export TEST_TAGS=integration; make docker-test` with all new code and make sure it will pass when it hits CI

5. Commit and push


### SKU Tokens

SKU Tokens represent cookie-like objects with domain specific caveats, new tokens can be created following the instructions in [this readme](https://github.com/brave-intl/bat-go/tree/master/tools/macaroon/cmd/README.md)
Expand Down

0 comments on commit 8aca674

Please sign in to comment.