abaiken/entitlements-api-go

Entitlements API reimplementation

Entitlements Service

SKU/Bundle changes

• The /bundles/bundles.example.yml file in this repo is for local testing only
• To run the app, be sure to copy /bundles/bundles.example.yml to /bundles/bundles.yml
• To make SKU changes for the live service, see the entitlements-config repository: https://github.com/RedHatInsights/entitlements-config

Application Setup

Install Golang:

sudo dnf install golang # or brew install go on OSX

Clone this repo:

git clone [email protected]:RedHatInsights/entitlements-api-go.git

Then, install the project's Go dependencies by running:

bash ./scripts/dev_deps.sh

Certificates and Configuration

Getting an Enterprise Cert

To run the Entitlements API locally, you will need an Enterprise Services cert with access to the dev subscription endpoint /search/criteria and the export compliance service in whatever environment you are testing in.

• You can request a personal cert by following ALL steps in this mojo doc.
• You can request access to export compliance service by following the appropriate steps in this doc.
• You can export your crt and key like so: openssl pkcs12 -in your-p12-cert.p12 -out your-key.key -nocerts -nodes openssl pkcs12 -in your-p12-cert.p12 -out your-cert-sans-key.crt -clcerts -nokeys

Create your config file

You'll need to make a config file specific to your machine. Create a local config directory: mkdir -p ./local Add a file that contains your local configuration options: $EDITOR ./local/qa.conf.sh The contents should look like this:

export ENT_KEY=./{path_to_key}.key
export ENT_CERT=./{path_to_cert}.crt
export ENT_CA_PATH=./{path_to_ca_cert}.crt
export ENT_SUBS_HOST=https://subscription.dev.api.redhat.com
export ENT_COMPLIANCE_HOST=https://export-compliance.dev.api.redhat.com

Replace {path_to_key} and {path_to_cert} with the locations of the .key and .crt files from the previous section.

Set up your local entitlement bundles

Copy the /bundles/bundles.example.yml to /bundles/bundles.yml in order to have your local app consume bundle data. You can modify this file for local testing. Note: This file is for local testing only. If you wish to make changes to the actual bundles, please refer to https://github.com/RedHatInsights/entitlements-config

Running the Application

Now that everything is set up, you can run the application using:

bash ./scripts/watch.sh ./local/development.env.sh

To run locally with Docker:

docker build -t entitlements-api-go .
docker run -p 3000:3000 entitlements-api-go

Testing Entitlements API with curl

The Entitlements API requires that you pass in a valid x-redhat-identity header or it rejects requests. For an example see cat ./scripts/xrhid_helper.sh

Testing the bundle-sync

To test the bundle sync behavior, you'll need to configure your environment similar to the insructions above, build the script, and run it against the dev environment:

. ./local/development.env.sh
go build -o ./bundle-sync bundle_sync/main.go
./bundle-sync

Running the Unit Tests

• To run the unit tests, execute the following commands from the terminal: cd controllers go test
• To include benchmarks: cd controllers go test -bench=.