Skip to content

Community implementation

Rustam Lotsmanenko (EPAM) requested to merge community-impl into master



More details about the solution:

As a part of the community implementation solution schema-gc module was refactored to the schema-core-plus module, in addition new pluggable approach for Drivers was used.

What is the current behavior?

  • We do not have the core-plus module.
  • Drivers not pluggable, all dependencies bounded during the compile step.

What is the new behavior?

  • We have the core-plus module.
  • Drivers are pluggable and could be attached to service during image build, not compile.

Key components of pluggable configuration:

  1. Add spring boot loader to service dependencies to core-plus service pom.xml, in this MR this dependency was added to schema-core-plus pom.xml
  1. Update service configuration to use Properties launcher from spring boot loader as the main class, in the same schema-core-plus pom.xml:
  1. Download plugin artifacts(jar files) before building a Docker image or running it locally. The location could be any, the only requirement is to be accessible for running env or Docker image build:
    - mvn dependency:copy -DrepoUrl=$OSM_PACKAGE_REGISTRY_URL -Dartifact="org.opengroup.osdu:os-osm-postgres:$OSM_VERSION:jar:plugin" -Dtransitive=false -DoutputDirectory="./tmp"
    - mvn dependency:copy -DrepoUrl=$OBM_PACKAGE_REGISTRY_URL -Dartifact="org.opengroup.osdu:os-obm-minio:$OBM_VERSION:jar:plugin" -Dtransitive=false -DoutputDirectory="./tmp"
    - mvn dependency:copy -DrepoUrl=$OQM_PACKAGE_REGISRTY_URL -Dartifact="org.opengroup.osdu:os-oqm-rabbitmq:$OQM_VERSION:jar:plugin" -Dtransitive=false -DoutputDirectory="./tmp"
  1. Copy plugin jars into the Docker image:
COPY tmp/os-oqm-rabbitmq-*.jar plugins/oqm-rabbitmq.jar
COPY tmp/os-obm-minio-*.jar plugins/osm-minio.jar
COPY tmp/os-osm-postgres-*.jar plugins/osm-postgres.jar
  1. Bundle service with plugins using run args, point to the directory with plugins, and point to the original main class:
java ...
         -Dloader.path=plugins/ \ \
         -jar /app/schema-${PROVIDER_NAME}.jar

How to test:

Via integration tests.

Changes include:

  • Refactor (a non-breaking change that improves code maintainability).
  • Bugfix (a non-breaking change that solves an issue).
  • New feature (a non-breaking change that adds functionality).
  • Breaking change (a change that is not backward-compatible and/or changes current functionality).

Changes in:

  • Common code

Dev Checklist:

  • Added Unit Tests, wherever applicable.
  • Updated the Readme, if applicable.
  • Existing Tests pass
  • Verified functionality locally
  • Self Reviewed my code for formatting and complex business logic.
Edited by Rustam Lotsmanenko (EPAM)

Merge request reports