The System Model component provides a source of truth for the main entities of the system. It is intended usage is that high-level managers will perform CRUD operations, while lower-level components may have read/update access if required.
This component is divided into three big sections: entities, providers and server
- Entities: contains all entity definitions, functions to translates of or to grpc structs and the validations
- Provider: contains all the providers required. Exist two types of providers: mockup (or memory) providers and scylladb providers. Each Scylla provider has an equivalent Mockup provider. Both will pass the same tests. This allows us not to have integration tests on the servers
- Server: contains all the logic of the component.
To run system-model, we need a ScyllaDB installation.
In order to build and compile this repository use the provided Makefile:
make all
This operation generates the binaries for this repo, download dependencies, run existing tests and generate ready-to-deploy Kubernetes files.
Tests are executed using Ginkgo. To run all the available tests:
make test
Dependencies are managed using Godep. For an automatic dependencies download use:
make dep
In order to have all dependencies up-to-date run:
dep ensure -update -v
Some integration tests are included. To execute those, set up the following environment variables. The execution of integration tests may have collateral effects on the state of the platform. DO NOT execute those tests in production, after each test, the tables are truncated
The following table contains the variables that activate the integration tests
| Variable | Example Value | Description |
|---|---|---|
| RUN_INTEGRATION_TEST | true | Run integration tests |
| IT_SCYLLA_HOST | 127.0.0.1 | Scylla Address |
| IT_SCYLLA_PORT | 9042 | Scylla Port |
| IT_NALEJ_KEYSPACE | nalej | Keyspace name |
The database must be created to run the integration test. There is a file scripts/database.cql that contains all the
sentences to create the keyspace and the tables needed
All the operations related to accounts and projects are not available yet. It will be ready in future releases
Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the Apache 2.0 License - see the LICENSE-2.0.txt file for details.