Skip to content

Add environment variable check on document genenerator startup #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mathsh wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add environment variable check on document genenerator startup #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8de55fc
Added function to check environmental variables are present on start up
Mathsh Feb 12, 2019
ceaaad5
Updated log error to add exception
Mathsh Feb 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .../main/java/uk/gov/companieshouse/document/generator/api/DocumentGeneratorApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,42 @@
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import uk.gov.companieshouse.document.generator.api.interceptor.LoggingInterceptor;
import uk.gov.companieshouse.environment.EnvironmentReader;
import uk.gov.companieshouse.environment.exception.EnvironmentVariableException;
import uk.gov.companieshouse.environment.impl.EnvironmentReaderImpl;
import uk.gov.companieshouse.logging.Logger;
import uk.gov.companieshouse.logging.LoggerFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;

@SpringBootApplication
public class DocumentGeneratorApplication implements WebMvcConfigurer {

public static final String APPLICATION_NAME_SPACE = "document-generator-api";

public static final String DOCUMENT_RENDER_SERVICE_HOST_ENV_VAR = "DOCUMENT_RENDER_SERVICE_HOST";

public static final String DOCUMENT_BUCKET_NAME_ENV_VAR = "DOCUMENT_BUCKET_NAME";

private static final String CHS_API_KEY = "CHS_API_KEY";

private static final String API_URL = "API_URL";

private static final Logger LOGGER = LoggerFactory.getLogger(APPLICATION_NAME_SPACE);

@Autowired
private LoggingInterceptor loggingInterceptor;

private static EnvironmentReader reader;

public static void main(String[] args) {

reader = new EnvironmentReaderImpl();

checkEnvironmentParams();

Integer port = Integer.getInteger("server.port");

if (port == null) {
Expand All @@ -30,6 +52,41 @@ public static void main(String[] args) {
SpringApplication.run(DocumentGeneratorApplication.class, args);
}

/**
* Check all expected Environment variables are set
*/
public static void checkEnvironmentParams() {

List<String> environmentParams = new ArrayList<>();

environmentParams.add(DOCUMENT_RENDER_SERVICE_HOST_ENV_VAR);
environmentParams.add(DOCUMENT_BUCKET_NAME_ENV_VAR);
environmentParams.add(CHS_API_KEY);
environmentParams.add(API_URL);
checkParams(environmentParams);
}

private static void checkParams(List<String> environmentParams) {

AtomicBoolean environmentParamMissing = new AtomicBoolean(false);

environmentParams.stream().forEach(param -> {

try {
String paramValue = reader.getMandatoryString(param);
LOGGER.info("Environment variable " + param + " has value " + paramValue);
} catch (EnvironmentVariableException e) {
LOGGER.error("Environment variable " + param + " is not set", e);
environmentParamMissing.set(true);
}
});

if (environmentParamMissing.get() == true) {
throw new RuntimeException("There are environment variables that " +
"are not set, see logs for details - application will exit");
}
}

@Override
public void addInterceptors(final InterceptorRegistry registry) {

Expand Down
20 changes: 9 additions & 11 deletions .../gov/companieshouse/document/generator/api/service/impl/DocumentGeneratorServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
package uk.gov.companieshouse.document.generator.api.service.impl;

import static uk.gov.companieshouse.document.generator.api.DocumentGeneratorApplication.APPLICATION_NAME_SPACE;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.apache.http.HttpStatus;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import uk.gov.companieshouse.document.generator.api.DocumentGeneratorApplication;
import uk.gov.companieshouse.document.generator.api.document.DocumentType;
import uk.gov.companieshouse.document.generator.api.document.description.RetrieveApiEnumerationDescription;
import uk.gov.companieshouse.document.generator.api.document.render.RenderDocumentRequestHandler;
Expand All @@ -31,6 +27,12 @@
import uk.gov.companieshouse.logging.Logger;
import uk.gov.companieshouse.logging.LoggerFactory;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import static uk.gov.companieshouse.document.generator.api.DocumentGeneratorApplication.APPLICATION_NAME_SPACE;

@Service
public class DocumentGeneratorServiceImpl implements DocumentGeneratorService {

Expand All @@ -44,10 +46,6 @@ public class DocumentGeneratorServiceImpl implements DocumentGeneratorService {

private RetrieveApiEnumerationDescription retrieveApiEnumerationDescription;

private static final String DOCUMENT_RENDER_SERVICE_HOST_ENV_VAR = "DOCUMENT_RENDER_SERVICE_HOST";

private static final String DOCUMENT_BUCKET_NAME_ENV_VAR = "DOCUMENT_BUCKET_NAME";

private static final String S3 = "s3://";

private static final String CONTEXT_PATH = "/document-render/store";
Expand Down Expand Up @@ -177,7 +175,7 @@ private RenderDocumentResponse renderSubmittedDocumentData(DocumentRequest docum
Map<String, String> requestParameters)
throws IOException, RenderServiceException {

String host = environmentReader.getMandatoryString(DOCUMENT_RENDER_SERVICE_HOST_ENV_VAR);
String host = environmentReader.getMandatoryString(DocumentGeneratorApplication.DOCUMENT_RENDER_SERVICE_HOST_ENV_VAR);
String url = host + getContextPath(documentRequest.isPublicLocationRequired());

RenderDocumentRequest requestData = new RenderDocumentRequest();
Expand Down Expand Up @@ -243,7 +241,7 @@ private void setContentAndDocumentType(String mimeType, String documentType, Ren
*/
private String buildLocation(String path) {

String bucketName = environmentReader.getMandatoryString(DOCUMENT_BUCKET_NAME_ENV_VAR);
String bucketName = environmentReader.getMandatoryString(DocumentGeneratorApplication.DOCUMENT_BUCKET_NAME_ENV_VAR);

return new StringBuilder(S3).append(bucketName).append(path).toString();
}
Expand Down