https://github.com/access-company/testgear
Test gear application for Antikythera Framework
https://github.com/access-company/testgear
antikythera api-server elixir erlang-otp
Last synced: 3 months ago
JSON representation
Test gear application for Antikythera Framework
- Host: GitHub
- URL: https://github.com/access-company/testgear
- Owner: access-company
- License: apache-2.0
- Created: 2018-04-02T05:19:30.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T09:31:25.000Z (over 1 year ago)
- Last Synced: 2025-04-16T01:55:22.566Z (about 1 year ago)
- Topics: antikythera, api-server, elixir, erlang-otp
- Language: Elixir
- Homepage:
- Size: 155 KB
- Stars: 4
- Watchers: 29
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Testgear
A gear application of [Antikythera]. As the name suggests, used for testing [Antikythera]'s core functionality.
[Antikythera]: https://github.com/access-company/antikythera
Testgear is:
- installable to any [Antikythera] instances
- utilized in [upgrade compatibility test](https://github.com/access-company/antikythera/blob/master/local/mix/upgrade_compatibility_test.ex)
- also, a sample case of gear application implementation
## Installation
Testgear can be installed to any Antikythera instances.
To do so, you must supply `ANTIKYTHERA_INSTANCE_DEP` environment variable.
It must declare dependency to your Antikythera instance in the form of dependency tuple,
just like you do in ordinary `mix.exs` file.
Example sequence up to compilation:
```sh
$ git clone https://github.com/access-company/testgear.git
$ cd testgear
$ ANTIKYTHERA_INSTANCE_DEP='{:instance_name, [git: "git@github.com:your-organization/instance_name.git"]}'
$ export ANTIKYTHERA_INSTANCE_DEP
$ mix deps.get
* Getting instance_name (git@github.com:your-organization/instance_name.git)
... (snip)
$ mix deps.get # Fetch dev/test-only dependencies declared in instance_name
$ mix compile
$ unset ANTIKYTHERA_INSTANCE_DEP
```
`ANTIKYTHERA_INSTANCE_DEP` is required **whenever `mix` is involved**, since testgear's `mix.exs` file depends on its value.
When you run already compiled Testgear with your Antikythera instance release (generated by [mix task](https://github.com/access-company/antikythera/blob/master/core/mix/generate_release.ex)),
all necessary information are stored in `testgear.app` so the environment variable is no longer needed.
## Copyright and License
Copyright(c) 2015-2024 [ACCESS CO., LTD](https://www.access-company.com). All rights reserved.
Antikythera source code is licensed under the [Apache License version 2.0](./LICENSE).