Skip to content

Latest commit

 

History

History
90 lines (79 loc) · 6.5 KB

README.md

File metadata and controls

90 lines (79 loc) · 6.5 KB
Raw

OpenLMIS Example Extensions

This example is a Docker image containing extensions of OpenLMIS services. It is meant to demonstrate how extensions are added to openlmis-ref-distro.

Quick start

  1. Fork/clone this repository from GitHub.
git clone https://github.com/OpenLMIS/openlmis-example-stockmanagement-validator-extension.git
  1. Add an environment file called .env to the root folder of the project, with the required project settings and credentials. For a starter environment file, you can use this one. eg:
curl -o .env -L https://raw.githubusercontent.com/OpenLMIS/openlmis-ref-distro/master/settings-sample.env
  1. Start up the application.
docker-compose -f ref-distro-example-docker-compose.yml up

  1. Check if the application behavior has changed according to the implemented extension point.

  2. Bean of implemented extension point should be also visible in docker-compose logs. To see extended logs add this loggers to the env file of ref-distro.

 logging.level.org.springframework.beans.factory=DEBUG
 logging.level.org.springframework.core.io.support=DEBUG
 logging.level.org.springframework.context.annotation=DEBU

Integration with openlmis-ref-distro

  1. Fork/clone openlmis-ref-distro repository from GitHub.
git clone https://github.com/OpenLMIS/openlmis-ref-distro.git
  1. Start up openlmis-ref-distro.
   docker-compose -f docker-compose.openlmis-stockmanagement-validator-extension.yml up

Adding extension points

  1. Add extension to the "dependencies" configuration in build.gradle:
    extension "org.openlmis:openlmis-stockmanagement-validator-extension:0.0.1-SNAPSHOT"
  1. Modify extensions.properties with name of the extended component.
    AdjustmentReasonValidator=NoneValidator
    FreeTextValidator=ReasonFreeTextValidator
    UnpackKitValidator=NoKitsValidator

Configuring openlmis-ref-distro

The Reference Distribution is configured to use extension modules by defining a named volume that is common to the service and partner image.

volumes:
  example-extensions:
    external: false

The shared volume contains extension jars and extension point configuration. The role of this image is to copy them at start-up, so they may be read by the service.

An example configuration can be found in openlmis-ref-distro as docker-compose.openlmis-stockmanagement-validator-extension.yml.

Implementing new Extension Point in OpenLMIS

Prepare core service to enable extensions

  1. Add ExtensionManager and ExtensionException to src/extension in the repository where extension point should be included (See commit here).
  2. Add extension point interface in src/extension/point, for example: AdjustmentReasonValidator.
  3. Add final ExtensionPointId class with the extension point ids defined like here.
  4. Add Default class which implements the extension point interface. See an example. Default class needs to have Component annotation with the value of its id:
@Component(value = "DefaultAdjustmentReasonValidator")
  1. Update the usage of the extension point. Now it should use ExtensionManager to find proper implementation. See example here.
  2. Add runtime dependency to build.gradle file in the repository like here.
  3. In build.gradle add tasks that sign archives and publishes repository itself to Maven (check details in this ticket).
  4. Run the CI build job to publish the repository to Maven.

Extension point implementation and usage

  1. Create a new extension module, which contains code that overrides extension point, for example: openlmis-stockmanagement-validator-extension.
  2. Annotate your implementation of the extension point with @Component annotation with the value of its id like here.
  3. Create an appropriate CI job (example). Build the job to publish the repository to Maven.
  4. Create a new extensions module which collects extension points for all services. The openlmis-example-extensions is an example of such a module.
  5. Modify extensions.properties with the name of the extended component
  6. Add the extension to the "dependencies" configuration in build.gradle.
  7. Create a dedicated docker-compose.yml file with the example-extensions service. See the example: docker-compose.openlmis-stockmanagement-validator-extension.yml.
  8. Add the extensions module as volume to the extended service in the docker-compose.yml file.