Skip FOLIO Project Navigation

GitHub and Twitter:

Conduct local development

This lesson introduces some ways to do local development using this VM.

Front-end development

As explained earlier in this tutorial, the Stripes CLI is your friend.

Refer to the Stripes CLI User Guide.

Back-end development

It is possible to make a back-end module service that is running on your host system available to the Okapi system running in the Vagrant VM.

The separate document Running backend modules on your host system explains the configuration.

Module dependency graph

To determine dependencies of a certain module, following this technique.

Create a new tenant with nothing installed, then simulate installation of the module in question, to show what other modules that it would require to be installed.

(Note: As explained in Lesson 1, if the VM is recently launched then wait a while because Okapi will still be starting modules.)

#!/usr/bin/env bash

# install a fresh tenant and show dependency graph

MODULE=${1:-"mod-inventory"}

TENANT="depgraph"

OKAPIURL="http://localhost:9130"
CMD_CURL="curl"
CURL="$CMD_CURL -w '\n' -D - "
PATH_TMP="/tmp/folio-depgraph"

H_TENANT="-HX-Okapi-Tenant:$TENANT"
H_JSON="-HContent-type:application/json"

echo "Pulling updated ModuleDescriptors from registry ..."
$CURL $H_JSON -X POST \
  -d '{ "urls": [ "https://folio-registry.dev.folio.org" ] }' \
  $OKAPIURL/_/proxy/pull/modules

echo
echo "Initialise the tenant '$TENANT' ..."
cat >$PATH_TMP-tenant.json << END
{
  "id" : "$TENANT",
  "name" : "Dependency grapher"
}
END
${CMD_CURL} -s -S $H_JSON -X POST \
  -d @$PATH_TMP-tenant.json \
  $OKAPIURL/_/proxy/tenants

echo
echo "Enable Okapi internal module for tenant '$TENANT' ..."
${CMD_CURL} -s -S $H_JSON -X POST \
  -d '{"id":"okapi"}' \
  $OKAPIURL/_/proxy/tenants/$TENANT/modules

echo
echo "Get dependency graph for '$MODULE' ..."
cat >$PATH_TMP-enable.json << END
[{"id":"$MODULE","action":"enable"}]
END
${CMD_CURL} -s -S $H_JSON -X POST \
  -d @$PATH_TMP-enable.json \
  "$OKAPIURL/_/proxy/tenants/$TENANT/install?simulate=true"
echo

Deploy a module

First verify the Module dependency graph.

If that step is not done, then still need to get the updated ModuleDescriptors from the registry. These will be the ModuleDescriptors that have been published since this VM was constructed.

(Note: As explained in Lesson 1, if the VM is recently launched then wait a while because Okapi will still be starting modules.)

curl -w '\n' -HContent-type:application/json -X POST \
  -d '{ "urls": [ "https://folio-registry.dev.folio.org" ] }' \
  http://localhost:9130/_/proxy/pull/modules

Now, assuming that this VM has the required module dependencies, proceed to enable and deploy the module.

Here installing “mod-courses” for the default tenant “diku”, which we know has the dependencies already satisfied. If not sure then “simulate” first.

curl -w '\n' -HContent-type:application/json -X POST \
  -d '[ { "id": "mod-courses", "action": "enable" } ]' \
  http://localhost:9130/_/proxy/tenants/diku/install?simulate=true

No errors, so proceed for real:

curl -w '\n' -HContent-type:application/json -X POST \
  -d '[ { "id": "mod-courses", "action": "enable" } ]' \
  http://localhost:9130/_/proxy/tenants/diku/install?deploy=true

The Okapi logfile would have said on which port the module was deployed (e.g. 9160). So do a health check. Of course this needs to be run from within the VM, as that is not one of the forwarded ports.

vagrant ssh
curl -w '\n' http://localhost:9160/admin/health

From the host machine, conduct some queries as explained in the module API documentation (mod-courses). As explained in the previous lesson, need to login first.