⛔️ This project is now archived - No Maintenance Intended

object-store-harvestor

Contents

• Object Store Harvestor
  • Docs
  • Prerequisites
  • Local development
  • Running the tests
  • Built With
  • Artifacts
  • Versioning
  • Deployment

Docs

• Application Design
• Application Diagram
• Persistent Storage Design
• Persistent Storage Diagram
• Application Config

Local development

• prerequisites

  • Install Docker
  • Install docker-compose
  • Setup dina-local-deployment

  Docer local development

  • clone the repo: object-store-harvestor
  • cd to repo object-store-harvestor
  • run the following command to start a docker container :

    ./run_docker_containers.sh
    

  local development (linux)

  • clone the repo: object-store-harvestor
  • cd to repo object-store-harvestor
  • cd harvestor
  • run the following command to start a docker container :

    ./develop_run.sh
    

Running the tests

All tests run in local develoment for both docker anf Linux If any of the test fail the full development run will fail. All details will be provided in stdout.

Break down into end to end tests

There are 2 types of tests:

• Unit tests (covering everything)
• Integration tests (covering everything except API calls, API calls are all mocked)

Built With

• GitHub actions : https://github.com/AAFC-BICoE/object-store-harvestor/actions

Artifacts

• executable binary file
• config yml file

Versioning

• Naming convention : vxxx.yyy (example : v0.4)

Deployment

• TODO