Skip to content

Latest commit

 

History

History
162 lines (128 loc) · 6.57 KB

README.md

File metadata and controls

162 lines (128 loc) · 6.57 KB
Raw

Ruby Style Guide CI

Handle Rest

Ruby interface to the CNRI Handle System REST API. The CNRI Handle Server provides a DNS-like method of providing persistent URLs to resources. The REST API is available from Handle Server 8.0 onwards. The HANDLE.NET Technical Manual documents the REST API.

Installation

Add this line to your application's Gemfile:

gem 'handle_rest'

And then execute:

$ bundle

Or install it yourself as:

$ gem install handle_rest

Usage

require 'handle_rest'

# Set up the handle service connection
handle_service = HandleService.new(url: 'https://hdl.example.com:8000/api/handles',
                                   user: '300:0.NA/PREFIX', 
                                   password: 'secret')

# Set up the service to add the admin value line to all new handles
admin = Identity.from_s('300:0.NA/PREFIX')
admin_value = AdminValue.new(admin.index, AdminPermissionSet.new, admin.handle)
admin_value_line = ValueLine.new(100, admin_value)
service = Service.new([admin_value_line], handle_service)

# Set up the URL service to store the URL at index 1
url_service = UrlService.new(1, service)

# Create a handle with a URL
url_service.set('PREFIX/Suffix', 'http://example.com')

# Retrieve the URL from the handle
puts url_service.get('PREFIX/Suffix')

# Update the URL of the handle
url_service.set('PREFIX/Suffix', 'https://www.example.com')

# Retrieve the new URL from the handle
puts url_service.get('PREFIX/Suffix')

# Delete the handle
service.delete(Handle.from_s('PREFIX/Suffix'))

Running the integration tests

By default rspec will not run the integration tests, because they require a test handle server. If you have a test handle server available, set the following environment variables:

# Set this environment variable to run the integration tests
INTEGRATION=1
# Set to the URL for the test handle server
HS_REST_URL=https://localhost:8000/api/handles/
# Set to a homed prefix for the test handle server (including the trailing '/')
HS_PREFIX=9999/
# Set to appropriate credentials for a user that can create handles in the 
# given prefix. Currently, the API only supports password ('secret key')
# authentication.
HS_USER=300:9999/ADMIN
HS_SECKEY=password
# Set to 0 if the test handle server has a self-signed or otherwise invalid SSL
# certificate
HS_SSL_VERIFY=0

export INTEGRATION HS_REST_URL HS_USER HS_SECKEY HS_SSL_VERIFY

Setting up a test handle server

  • Ensure java is installed
  • Download and unpack the handle server
  • Follow the installation instructions from Section 3 "Installing and Running a Handle Server" from the technical manual up through section 3.4 "Running the Setup Program". Do NOT try to home a prefix with the handle admin tool (section 3.5), since this is only a test server.

Next, manually home a test prefix and add an administrative user. This example uses 9999 as the prefix and 9999/ADMIN as the administrative user, but you can use whatever you want so long as it's consistent.

  • Set server_admins and replication_admins in config.dct to 300:9999/ADMIN
  • Set auto_homed_prefixes in config.dct to 0.NA/9999
  • Run hdl-dbtool $HS_HOME
  • Add a homed test prefix, 0.NA/9999
  • Create a handle for an administrative user, 9999/ADMIN, with values as follows:
    • index 100, type HS_ADMIN, data type admin info, with admin ID handle 9999/ADMIN, admin ID index 200, and all permissions selected
    • index 200, type HS_VLIST, data type reference list, and one value: handle 9999/ADMIN, index 300
    • index 300, type HS_SECKEY, data type string, set to the password you want to use for the administrative user (warning: this is stored in plain text in the database)
  • Start the handle server: hdl-server $HS_HOME

Containers

docker-compose

You may also run the integration tests using docker-compose. To generate the docker-compose.yml file using the environment variables defined in the .env file run the yml-envsubst.sh shell script in the bin directory.

./bin/yml-envsubst.sh docker-compose.yml

The docker-compose.yml file will pull images from the ${GITHUB_USER} account but first you'll need to create them using the build-image.sh and push-image.sh shell scripts in the bin directory.

./bin/build-image.sh ./image/mysql
./bin/push-image.sh ./image/mysql
./bin/build-image.sh ./image/ihs-handle-server
./bin/push-image.sh ./image/ihs-handle-server
./bin/build-image.sh .
./bin/push-image.sh .

The push-image.sh shell script will use the ${GITHUB_WRITE_PACKAGES_TOKEN} from the shell environment which must have write packages permission for the ${GITHUB_USER}. To run the tests use docker-compose up.

docker-compose up

When the test finish you'll have to ctrl-c to interrupt and stop the services and then run docker-compose down to tidy things up.

docker-compose down --remove-orphans

docker kubernetes

You may also run the integration tests in your Docker Desktop Kubernetes cluster. You'll have to generate the kubernetes manifest using the yml-envsubst.sh shell script in the bin directory against the *.yml.envsubst files in the kube/docker-desktop directory. For example:

./bin/yml-envsubst.sh ./kube/docker-desktop/po/spec.yml

Note: ./kube/docker-desktop/secret/github-packages-read.yml manifest uses ${GITHUB_PACKAGES_READ} environment variable which is generated from the

export GITHUB_PACKAGES_READ=`echo "${GITHUB_USER}:${GITHUB_READ_PACKAGES_TOKEN}" | base64`

inside the yml-envsubst.sh shell script. The ${GITHUB_READ_PACKAGES_TOKEN} must have read packages permission for the ${GITHUB_USER}.

Once you generate all the manifest use kubectl apply to populate your desktop cluster, for example:

kubectl apply -f ./kube/docker-desktop/secret/github-packages-read.yml

You'll need to kubectl exec into pod/spec to manually run the specs.

kubectl exec -it pod/spec -- bash

then

bundle exec rake

Not the prettiest implementation of containers but all you need is docker, kubectl and bash which is something.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request