Skip to content

Commit

Permalink
FI-2544 Release v0.9.0 IPS Test Kit (#35)
Browse files Browse the repository at this point in the history
* Up to v0.9.0

* Update readme
  • Loading branch information
arscan authored Mar 7, 2024
1 parent 069e030 commit 6c1b76f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 43 deletions.
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
ips_test_kit (0.1.1)
ips_test_kit (0.9.0)
inferno_core (>= 0.4.21)

GEM
Expand Down
50 changes: 9 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,17 @@ a preliminary test suite.

## Instructions

- Clone this repo.
- Write your tests in the `lib` folder.
- Put the `package.tgz` for the IG you're writing tests for in
`lib/your_test_kit_name/igs` and update this path in `docker-compose.yml`.
This will ensure that the validator has access to the resources needed to
validate resources against your IG.
- Run `setup.sh` in this repo to pull the needed docker images and set up the
database.
- Run `run.sh` to build your tests and run inferno.
- Navigate to `http://localhost` to access Inferno, where your test suite will
be available. To access the FHIR resource validator, navigate to
`http://localhost/validator`.

## Distributing tests

In order to make your test suite available to others, it needs to be organized
like a standard ruby gem (ruby libraries are called gems).
It is highly recommended that you use [Docker](https://www.docker.com/) to run
these tests. This test kit requires at least 10 GB of memory are available to Docker.

- Fill in the information in the `gemspec` file in the root of this repository.
The name of this file should match the `spec.name` within the file. This will
be the name of the gem you create. For example, if your file is
`my_test_kit.gemspec` and its `spec.name` is `'my_test_kit'`, then others will
be able to install your gem with `gem install my_test_kit`. There are
[recommended naming conventions for
gems](https://guides.rubygems.org/name-your-gem/).
- Your tests must be in `lib`
- `lib` should contain only one file. All other files should be in a
subdirectory. The file in lib be what people use to import your gem after they
have installed it. For example, if your test kit contains a file
`lib/my_test_suite.rb`, then after installing your test kit gem, I could
include your test suite with `require 'my_test_suite'`.
- **Optional:** Once your gemspec file has been updated, you can publish your
gem on [rubygems, the official ruby gem repository](https://rubygems.org/). If
you don't publish your gem on rubygems, users will still be able to install it
if it is located in a public git repository. To publish your gem on rubygems,
you will first need to [make an account on
rubygems](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg)
and then run `gem build *.gemspec` and `gem push *.gem`.

## Example Inferno test kits
- Clone this repo.
- Run `setup.sh` in this repo.
- Run `run.sh` in this repo.
- Navigate to `http://localhost`. The IPS Test suite will be available.

- https://github.com/inferno-community/ips-test-kit
- https://github.com/inferno-community/shc-vaccination-test-kit
See the [Inferno Framework
Documentation](https://inferno-framework.github.io/docs/getting-started-users.html)
for more information on running Inferno.

## License

Expand Down
2 changes: 1 addition & 1 deletion lib/ips/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module IPS
VERSION = '0.1.1'.freeze
VERSION = '0.9.0'.freeze
end

0 comments on commit 6c1b76f

Please sign in to comment.