https://github.com/arscan/walkthrough
https://github.com/arscan/walkthrough
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/arscan/walkthrough
- Owner: arscan
- License: apache-2.0
- Created: 2022-06-08T15:55:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-08T15:55:51.000Z (about 4 years ago)
- Last Synced: 2025-01-16T08:15:10.883Z (over 1 year ago)
- Language: Ruby
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inferno Template
This is a template repository for an
[Inferno](https://github.com/inferno-community/inferno-core) test kit.
## 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`.
## Documentation
- [Inferno documentation](https://inferno-framework.github.io/inferno-core/)
- [Ruby API documentation](https://inferno-framework.github.io/inferno-core/docs)
- [JSON API documentation](https://inferno-framework.github.io/inferno-core/api-docs)
## 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).
- 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
- https://github.com/inferno-community/ips-test-kit
- https://github.com/inferno-community/shc-vaccination-test-kit
## License
Copyright 2022 The MITRE Corporation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
```
http://www.apache.org/licenses/LICENSE-2.0
```
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.