CRS Catalog Service

The main goals of the Spatial Reference Catalog (aka crs-catalog) service are to offer:

1. Coordinate Reference Systems (CRSs) to enable end-users to make a CRS selection.
2. Search for CRSs given a number of constraints.
3. Download of the entire catalog for local caching and when the cache has to be refreshed.
4. Once a CRS is found, produce a persistable reference to be stored with the data, which fully describes the CRS; this persistable reference string becomes catalog independent. This means any consumer will be able to understand the CRS definition even if a different catalog is used in the future context.

Running Locally

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Pre-requisites

• JDK 8 (https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html)
• Maven 3.8.3 or later
• Lombok 1.16 or later
• OSDU Instance deployed on AWS

Service Configuration

In order to run the service locally or remotely, you will need to have the following environment variables defined.

Run Locally

Check that maven is installed:

example:

$ mvn --version
Apache Maven 3.8.3 (ff8e977a158738155dc465c6a97ffaf31982d739)
Maven home: /usr/local/Cellar/maven/3.8.3/libexec
Java version: 1.8.0_312, vendor: Amazon.com Inc., runtime: /Library/Java/JavaVirtualMachines/amazon-corretto-8.jdk/Contents/Home/jre
...

You may need to configure access to the remote maven repository that holds the OSDU dependencies. Copy one of the below files' content to your .m2 folder

• For development against the OSDU GitLab environment, leverage: <REPO_ROOT>~/.mvn/community-maven.settings.xml

• For development in an AWS Environment, leverage: <REPO_ROOT>/provider/crs-catalog-aws/maven/settings.xml

• Navigate to the service's root folder and run:

mvn clean package -pl crs-catalog-core,provider/crs-catalog-aws

• If you wish to build the project without running tests

mvn clean package -pl crs-catalog-core,provider/crs-catalog-aws -DskipTests

After configuring your environment as specified above, you can follow these steps to run the application. These steps should be invoked from the repository root.

NOTE: If not on osx/linux: Replace * with version numbers as defined in the provider/crs-catalog-aws/pom.xml file

java -jar provider/crs-catalog-aws/target/crs-catalog-aws-*.*.*-SNAPSHOT-spring-boot.jar

Testing

Running Integration Tests

This section describes how to run OSDU Integration tests (testing/crs-catalog-test-aws).

You will need to have the following environment variables defined.

Creating a new user to use for integration tests

aws cognito-idp admin-create-user --user-pool-id ${AWS_COGNITO_USER_POOL_ID} --username ${AWS_COGNITO_AUTH_PARAMS_USER} --user-attributes Name=email,Value=${AWS_COGNITO_AUTH_PARAMS_USER} Name=email_verified,Value=True --message-action SUPPRESS

aws cognito-idp initiate-auth --auth-flow ${AWS_COGNITO_AUTH_FLOW} --client-id ${AWS_COGNITO_CLIENT_ID} --auth-parameters USERNAME=${AWS_COGNITO_AUTH_PARAMS_USER},PASSWORD=${AWS_COGNITO_AUTH_PARAMS_PASSWORD}

Entitlements group configuration for integration accounts
In order to add user entitlements, run entitlements bootstrap scripts in the entitlements project

Execute following command to build code and run all the integration tests:

Run Tests simulating Pipeline

• Prior to running tests, scripts must be executed locally to generate pipeline env vars

testing/catalog_test_aws/build-aws/prepare-dist.sh

#Set Neccessary ENV Vars here as defined in run-tests.sh

dist/testing/integration/bin/catalog_test_aws/build-aws/run-tests.sh 

License

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.