README.md

os-legal-azure

os-legal-azure is a Spring Boot service that hosts CRUD APIs that enable management of legal tags within the OSDU R2 ecosystem.

Running Locally

Requirements

In order to run this service locally, you will need the following:

• Maven 3.6.0+
• AdoptOpenJDK8
• Infrastructure dependencies, deployable through the relevant infrastructure template
• While not a strict dependency, example commands in this document use bash

General Tips

Environment Variable Management The following tools make environment variable configuration simpler

• direnv - for a shell/terminal environment
• EnvFile - for Intellij IDEA

Lombok This project uses Lombok for code generation. You may need to configure your IDE to take advantage of this tool.

• Intellij configuration
• VSCode configuration

Environment Variables

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

Note The following command can be useful to pull secrets from keyvault:

az keyvault secret show --vault-name $KEY_VAULT_NAME --name $KEY_VAULT_SECRET_NAME --query value -otsv

Required to run service

name	value	description	sensitive?	source
LOG_PREFIX	legal	Logging prefix	no	-
legal_service_region	us	Legal service region	no	-
entitlements_service_endpoint	ex https://foo-entitlements.azurewebsites.net	Entitlements API endpoint	no	output of infrastructure deployment
entitlements_service_api_key	********	The API key clients will need to use when calling the service	yes	--
LEGAL_HOSTNAME	notused	Possibly unused	no	-
CRON_JOB_IP	10.0.0.1	Possibly unused	no	-
azure.activedirectory.session-stateless	true	Flag run in stateless mode (needed by AAD dependency)	no	--
aad_client_id	********	AAD client application ID	yes	output of infrastructure deployment
azure.activedirectory.AppIdUri	api://${azure.activedirectory.client-id}	URI for AAD Application	no	--
cosmosdb_database	ex dev-osdu-r2-db	Cosmos database for legal documents	no	output of infrastructure deployment
storage_account	ex devintosdur2storage	Storage account for legal documents	no	output of infrastructure deployment
azure.storage.container-name	ex legal-service-azure-configuration	Storage container for legal documents	no	output of infrastructure deployment
azure.storage.enable-https	true	Spring configuration for Azure Storage	no	-
servicebus_topic_name	legaltags	Topic for async messaging	no	output of infrastructure deployment
servicebus_namespace_name	ex foo-sb-namespace	Namespace for async messaging	no	output of infrastructure deployment
KEYVAULT_URI	ex https://foo-keyvault.vault.azure.net/	URI of KeyVault that holds application secrets	no	output of infrastructure deployment
AZURE_CLIENT_ID	********	Identity to run the service locally. This enables access to Azure resources. You only need this if running locally	yes	keyvault secret: $KEYVAULT_URI/secrets/app-dev-sp-username
AZURE_TENANT_ID	********	AD tenant to authenticate users from	yes	keyvault secret: $KEYVAULT_URI/secrets/app-dev-sp-tenant-id
AZURE_CLIENT_SECRET	********	Secret for $AZURE_CLIENT_ID	yes	keyvault secret: $KEYVAULT_URI/secrets/app-dev-sp-password
appinsights_key	********	API Key for App Insights	yes	output of infrastructure deployment

Required to run integration tests

name	value	description	sensitive?	source
INTEGRATION_TESTER	********	System identity to assume for API calls. Note: this user must have entitlements configured already	no	--
MY_TENANT	ex opendes	OSDU tenant used for testing	no	--
AZURE_TESTER_SERVICEPRINCIPAL_SECRET	********	Secret for $INTEGRATION_TESTER	yes	--
AZURE_AD_TENANT_ID	********	AD tenant to authenticate users from	yes	--
AZURE_AD_APP_RESOURCE_ID	********	AAD client application ID	yes	output of infrastructure deployment
AZURE_LEGAL_STORAGE_ACCOUNT	same as storage_account above	Storage account for integration tests	no	-
AZURE_LEGAL_STORAGE_KEY	********	Storage account key	yes	output of infrastructure deployment
AZURE_LEGAL_SERVICEBUS	********	Servicebus namespace connection string	yes	output of infrastructure deployment
AZURE_LEGAL_TOPICNAME	legaltags	Same as servicebus_topic_name above	no	-
HOST_URL	http://localhost:8080/	local service endpoint	no	-
ENTITLEMENT_URL	Same as entitlements_service_endpoint above	Endpoint for entitlements URL	no	-

Configure Maven

Check that maven is installed:

$ mvn --version
Apache Maven 3.6.0
Maven home: /usr/share/maven
Java version: 1.8.0_212, vendor: AdoptOpenJDK, runtime: /usr/lib/jvm/jdk8u212-b04/jre
...

You will need to configure access to the remote maven repository that holds the OSDU dependencies. This file should live within ~/.m2/settings.xml:

$ cat ~/.m2/settings.xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>os-core</id>
            <username>mvn-pat</username>
            <!-- Treat this auth token like a password. Do not share it with anyone, including Microsoft support. -->
            <!-- The generated token expires on or before 11/14/2019 -->
            <password>$PERSONAL_ACCESS_TOKEN_GOES_HERE</password>
        </server>
    </servers>
</settings>

Build and run the application

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

# build + test + install core service code
$ mvn clean install

# build + test + package azure service code
$ (cd provider/legal-azure/ && mvn clean package)

# run service
#
# Note: this assumes that the environment variables for running the service as outlined
#       above are already exported in your environment.
$ java -jar $(find provider/legal-azure/target/ -name '*-spring-boot.jar')

Test the application

After the service has started it should be accessible via a web browser by visiting http://localhost:8080/swagger-ui.html. If the request does not fail, you can then run the integration tests.

# build + install integration test core
$ (cd testing/legal-test-core/ && mvn clean install)

# build + run Azure integration tests.
#
# Note: this assumes that the environment variables for integration tests as outlined
#       above are already exported in your environment.
$ (cd testing/legal-test-azure/ && mvn clean test)

Debugging

Jet Brains - the authors of Intellij IDEA, have written an excellent guide on how to debug java programs.

Deploying service to Azure

Service deployments into Azure are standardized to make the process the same for all services. The steps to deploy into Azure can be found here

License

Copyright © Microsoft Corporation

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.