Plan Executor runs test suites against a FHIR server.
Updated to support the FHIR STU3 Candidate branch.
$ bundle install
$ bundle exec rake -T
List all the available Test Suites, excluding supported TestScripts
. Pass the version, which can currently either be dstu2
or stu3
.
$ bundle exec rake crucible:list_suites[dstu2]
Crucible tests can be executed by suite from the command-line by calling the crucible-execute
rake task with the following parameters:
url
the FHIR endpointversion
the FHIR version (sequence). Currentlydstu2
andstu3
are supported.test
the name of the test suite (seecrucible:list_suites
)resource
(optional) limit thetest
(applicable to "ResourceTest" or "SearchTest" suites) to a given resource (e.g. "Patient")
Run a DSTU2 Suite
$ bundle exec rake crucible:execute[http://fhirtest.uhn.ca/baseDstu2,dstu2,TransactionAndBatchTest]
Run a STU3 Suite limited by Resource
$ bundle exec rake crucible:execute[http://fhirtest.uhn.ca/baseDstu3,stu3,ResourceTest,Patient]
- Fork the repo
- Write the test suite in Ruby
- Issue a pull request
Add a Test Suite by adding a Ruby file to lib/tests/suites
that extends Crucible::Tests::BaseTest
-- for example, FooTest
:
module Crucible
module Tests
class FooTest < BaseSuite
def id
'FooTest'
end
def description
'FooTest is an example of adding a new test suite.'
end
def initialize(client1, client2=nil)
super(client1, client2)
@category = {id: 'connectathon', title: 'Connectathon'}
end
def setup
# create any fixtures you need here
@patient = ResourceGenerator.generate(FHIR::Patient,3)
reply = @client.create(@patient)
@id = reply.id
@body = reply.body
end
def teardown
# perform any clean up here
@client.destroy(FHIR::Patient, @id)
end
# test 'KEY', 'DESCRIPTION'
test 'FOO', 'Foo Test checks headers' do
metadata {
links "#{REST_SPEC_LINK}#read"
requires resource: "Patient", methods: ["create", "read"]
validates resource: "Patient", methods: ["read"]
}
assert(@id, 'Setup was unable to create a patient.',@body)
reply = @client.read(FHIR::Patient, @id)
assert_response_ok(reply)
assert_equal @id, reply.id, 'Server returned wrong patient.'
warning { assert_valid_resource_content_type_present(reply) }
warning { assert_etag_present(reply) }
warning { assert_last_modified_present(reply) }
end
end
end
end
Every Test Suite needs to override the following methods:
id
The unique id of the test, typically matches the class namedescription
The description that is displayed within the Crucible web appinitialize
Use the example above. Change the@category
-- theid
andtitle
determine where the test suite is categorized within the Crucible web appsetup
(optional) Use this method to create fixtures and perform any required assertions prior to execution of individualtest
blocks.test
These blocks are the individual tests within the suites. Each block should start with ametadata
section so Crucible knows how to tie the success or failures to portions of the FHIR specification (displayed in the web app with a starburst). Seelib/FHIR_structure.json
for the values associated with thename
keys that you can link to.teardown
(optional) Use this method to perform any clean up, so you don't leave a trail of test data behind.
Copyright 2014-2016 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.