Skip to content

Latest commit

 

History

History
117 lines (96 loc) · 5.28 KB

README.md

File metadata and controls

117 lines (96 loc) · 5.28 KB
Raw

Ruby Installation for Integration Verification Tests (IVT)

  1. Install homebrew: https://brew.sh/

  2. Install GNU Privacy Guard

    brew install gnupg gnupg2

    NOTE: This is dependent on Homebrew to be completely installed first.

  3. Install Ruby

    Directions here: https://rvm.io/rvm/install. Be sure to install RVM stable with ruby. You only need to follow Install GPG keys and Install RVM stable with ruby

  4. Ensure you can call rvm

    rvm list

  5. If they're not listed in the script response above, install ruby 2.6.5

    rvm install ruby-2.6.5
rvm use --default ruby-2.6.5
gem install bundler

  6. Run this script in the terminal in the same directory as Gemfile

    bundle install

    NOTE: Ensure gem install bundler completed first. It should exit with code 0 at the end.

  7. (Optional) If running in IntelliJ, configure this project as an RVM Ruby project

    • Install the Ruby plugin IntelliJ IDEA > Preferences... > Plugins
    • Configure Project File > Project Structure > Project Settings > Project and select RVM: ruby-2.6.5.
    • Configure Module File > Project Structure > Project Settings > Modules and reconfigure module with RVM Ruby.

    NOTE: Ensure that your Ruby versions match across terminal default, Gemfile, and Gemfile.lock. If using IntelliJ, Ruby version in your module should match as well.

  8. (Optional) To run tests locally, export these environment variables. Most of the values can be found in .github/workflows/ci-workflow.yml, and the remaining values should be found in your password manager.

    • APPID_TENANT
    • APPID_URL
    • CLOUD_API_KEY
    • ELASTIC_CRN
    • ELASTIC_PASSWORD
    • ELASTIC_URL
    • ELASTIC_USERNAME
    • HRI_URL
    • IAM_CLOUD_URL
    • JWT_AUDIENCE_ID
    • KAFKA_BROKERS
    • KAFKA_PASSWORD
    • TENANT_ID

    You will also need to set an environment variable called BRANCH_NAME that corresponds to your current working branch.

    Then, install the IBM Cloud CLI and the Event Streams CLI. You can find the RESOURCE_GROUP in .github/workflows/ci-workflow.yml and the CLOUD_API_KEY in your password manager:

    curl -sL https://ibm.biz/idt-installer | bash
bx login --apikey {CLOUD_API_KEY}
bx target -g {RESOURCE_GROUP}
bx plugin install event-streams
bx es init

    Select the number corresponding to the KAFKA_INSTANCE in .github/workflows/ci-workflow.yml.

    The last step before running the tests is to install the hri-test-helpers gem locally. Run the following commands:

       gem install specific_install
   gem specific_install -l [email protected]:Alvearie/hri-test-helpers.git -b main

    Then, add the following line to Gemfile, but do not commit this change to Github: gem 'hri-test-helpers

    Then, from within the top directory of this project, run the integration tests with:

    rspec test/spec --tag ~@broken

Troubleshooting

If you encounter rdkafka SSL root CA certificate errors, see Troubleshooting for instructions on how to update your local root CA certificates. To set the ssl.ca.location property for the tests, in test/spec/hri_deploy_helper.rb add it to the command line override of -kafka-properties, but ensure you don't commit this or it will break the GitHub Actions tests.

Dredd Tests

Dredd is used to verify the implemented API meets our published specification. By default, it generates a test for every endpoint, uses the example values for input, and verifies the response matches the 200 response schema. All other responses are skipped. Ruby 'hooks' are used to modify the default behavior and do setup/teardown. Here are some helpful documentation links:

Local Setup

Dredd is an npm package, so you first need to install nodejs. Homebrew is the easiest way.

brew install node

Then install dredd and api-spec-converter. Dredd currently only supports Swagger 2.0, so it's used to convert the API spec.

npm install -g api-spec-converter
npm install -g [email protected]

Next you have to install the dredd ruby gem to use Ruby 'hooks' with Dredd.

gem install dredd_hooks

Running Dredd Tests

First you need to convert the API spec to Swagger 2.0, so checkout the hri-api-spec repo. Then use api-spec-converter to convert it. You should make a branch with the same name if changes are needed. The build will checkout the same branch if it exists.

api-spec-converter -f openapi_3 -t swagger_2 -s yaml hri-api-spec/management-api/management.yml > hri-api-spec/management-api/management.swagger.yml

Then, from the hri-mgmt-api directory, run the Dredd tests:

dredd -r xunit -o dreddtests.xml ../hri-api-spec/management.swagger.yml ${HRI_URL/https/http} --sorted --language=ruby --hookfiles=test/spec/dredd_hooks.rb --hooks-worker-connect-timeout=5000

Debugging

Add -l debug to the dredd command to see additional logging and any puts statements from the ruby code. This is especially helpful when the code crashes.