GRAD2-2768

.github/workflows/build.from.dev.branch.deploy.to.dev.yml

@@ -128,7 +128,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # OVERRIDE Configmaps
  curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ github.event.inputs.choice }}/tools/config/override-configmap-dev.sh \
@@ -139,7 +140,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # Start rollout (if necessary) and follow it
  oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \

.github/workflows/build.from.main.branch.deploy.to.dev.yml

@@ -116,7 +116,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # OVERRIDE Configmaps
  curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/override-configmap-dev.sh \
@@ -127,7 +128,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # Start rollout (if necessary) and follow it
  oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \

.github/workflows/build.from.release.branch.deploy.to.dev.yml

@@ -123,7 +123,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # OVERRIDE Configmaps
  curl -s https://raw.githubusercontent.com/bcgov/${{ env.REPO_NAME }}/${{ env.BRANCH }}/tools/config/override-configmap-dev.sh \
@@ -134,7 +135,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # Start rollout (if necessary) and follow it
  oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \

.github/workflows/deploy_prod.yml

@@ -82,7 +82,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # Start rollout (if necessary) and follow it
  oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \

.github/workflows/deploy_test.yml

@@ -82,7 +82,8 @@ jobs:
  ${{ env.COMMON_NAMESPACE }} \
  ${{ env.BUSINESS_NAMESPACE }} \
  ${{ secrets.SPLUNK_TOKEN }} \
- ${{ vars.APP_LOG_LEVEL }}
+ ${{ vars.APP_LOG_LEVEL }} \
+ ${{ secrets.STUDENT_ADMIN_URL_ROOT }}
 
  # Start rollout (if necessary) and follow it
  oc rollout latest dc/${{ env.SPRING_BOOT_IMAGE_NAME }} 2> /dev/null \

.gitignore

@@ -54,5 +54,5 @@ build/
 ### VS Code ###
 .vscode/
 
-### local dev ###
+### Local dev ###
 **/application-local.yaml

api/pom.xml

@@ -24,14 +24,16 @@
  src/main/java/ca/bc/gov/educ/api/trax/model/**,
  src/main/java/ca/bc/gov/educ/api/trax/service/EventHandlerDelegatorService,
  src/main/java/ca/bc/gov/educ/api/trax/util/**,
- src/main/java/ca/bc/gov/educ/api/trax/repository/**
+ src/main/java/ca/bc/gov/educ/api/trax/repository/**,
+ src/main/java/ca/bc/gov/educ/api/trax/filter/**
  </sonar.exclusions>
  <sonar.junit.exclusions>
  src/main/java/ca/bc/gov/educ/api/trax/messaging/**,
  src/main/java/ca/bc/gov/educ/api/trax/scheduler/**,
  src/main/java/ca/bc/gov/educ/api/trax/model/**,
  src/main/java/ca/bc/gov/educ/api/trax/util/**,
- src/main/java/ca/bc/gov/educ/api/trax/repository/**
+ src/main/java/ca/bc/gov/educ/api/trax/repository/**,
+ src/main/java/ca/bc/gov/educ/api/trax/filter/**
  </sonar.junit.exclusions>
  <java.version>18</java.version>
  <maven.compiler.version>3.10.1</maven.compiler.version>
@@ -71,6 +73,11 @@
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
  </dependency>
+ <dependency>
+ <groupId>org.springframework.security</groupId>
+ <artifactId>spring-security-test</artifactId>
+ <scope>test</scope>
+ </dependency>
  <dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
@@ -83,6 +90,10 @@
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-pool2</artifactId>
  </dependency>
+ <dependency>
+ <groupId>org.springframework.boot</groupId>
+ <artifactId>spring-boot-starter-validation</artifactId>
+ </dependency>
  <dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
@@ -322,6 +333,11 @@
  <artifactId>lombok</artifactId>
  <version>${lombok.version}</version>
  </path>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok-mapstruct-binding</artifactId>
+ <version>0.2.0</version>
+ </dependency>
  <path>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context-indexer</artifactId>

api/src/main/java/ca/bc/gov/educ/api/trax/config/RestErrorHandler.java

@@ -1,63 +1,99 @@
 package ca.bc.gov.educ.api.trax.config;
 
+import ca.bc.gov.educ.api.trax.exception.ApiError;
+import ca.bc.gov.educ.api.trax.exception.EntityNotFoundException;
 import ca.bc.gov.educ.api.trax.exception.GradBusinessRuleException;
 import ca.bc.gov.educ.api.trax.util.ApiResponseMessage.MessageTypeEnum;
 import ca.bc.gov.educ.api.trax.util.ApiResponseModel;
 import ca.bc.gov.educ.api.trax.util.GradValidation;
+import lombok.extern.slf4j.Slf4j;
 import org.hibernate.dialect.lock.OptimisticEntityLockException;
 import org.hibernate.exception.ConstraintViolationException;
-import org.jboss.logging.Logger;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.dao.DataRetrievalFailureException;
+import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.ResponseEntity;
 import org.springframework.orm.jpa.JpaObjectRetrievalFailureException;
 import org.springframework.security.access.AccessDeniedException;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.springframework.http.HttpStatus.BAD_REQUEST;
+import static org.springframework.http.HttpStatus.NOT_FOUND;
+
+@Slf4j
 @ControllerAdvice
 public class RestErrorHandler extends ResponseEntityExceptionHandler {
 
- private static final Logger LOGGER = Logger.getLogger(RestErrorHandler.class);
+ GradValidation validation;
 
  @Autowired
- GradValidation validation;
+ public RestErrorHandler(GradValidation validation) {
+ this.validation = validation;
+ }
+
+ /**
+ * Override method handles exception thrown by @Valid validation
+ * on controller methods (for example)
+ */
+ @Override
+ protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatusCode status, WebRequest request) {
+ Map<String, String> errors = new HashMap<>();
+ ex.getBindingResult().getAllErrors().forEach(error -> {
+ String fieldName = ((FieldError) error).getField();
+ String errorMessage = error.getDefaultMessage();
+ errors.put(fieldName, errorMessage);
+ });
+ ApiError apiError = new ApiError(BAD_REQUEST);
+ apiError.setMessage(errors.toString());
+ return buildResponseEntity(apiError);
+ }
 
  @ExceptionHandler(value = { IllegalArgumentException.class, IllegalStateException.class })
- protected ResponseEntity<Object> handleConflict(RuntimeException ex, WebRequest request) {
- LOGGER.error("Illegal argument ERROR IS: " + ex.getClass().getName(), ex);
+ protected ResponseEntity<Object> handleConflict(RuntimeException ex) {
+ log.error("Illegal argument ERROR IS: {}", ex.getClass().getName(), ex);
  ApiResponseModel<?> response = ApiResponseModel.ERROR(null, ex.getLocalizedMessage());
- validation.ifErrors(errorList -> response.addErrorMessages(errorList));
- validation.ifWarnings(warningList -> response.addWarningMessages(warningList));
+ validation.ifErrors(response::addErrorMessages);
+ validation.ifWarnings(response::addWarningMessages);
  validation.clear();
  return new ResponseEntity<>(response, HttpStatus.UNPROCESSABLE_ENTITY);
  }
 
- @ExceptionHandler(value = { JpaObjectRetrievalFailureException.class, DataRetrievalFailureException.class })
- protected ResponseEntity<Object> handleEntityNotFound(RuntimeException ex, WebRequest request) {
- LOGGER.error("JPA ERROR IS: " + ex.getClass().getName(), ex);
- validation.clear();
- return new ResponseEntity<>(ApiResponseModel.ERROR(null, ex.getLocalizedMessage()), HttpStatus.BAD_REQUEST);
+ @ExceptionHandler(value = { JpaObjectRetrievalFailureException.class, DataRetrievalFailureException.class, EntityNotFoundException.class })
+ protected ResponseEntity<Object> handleEntityNotFound(RuntimeException ex) {
+ // no need to log EntityNotFoundExceptions as error
+ // it is used to denote NOT FOUND and is normal part of operations
+ if(!(ex instanceof EntityNotFoundException)){
+ log.error("JPA ERROR IS: {}", ex.getClass().getName(), ex);
+ }
+ ApiError apiError = new ApiError(NOT_FOUND);
+ apiError.setMessage(ex.getMessage());
+ return buildResponseEntity(apiError);
  }
 
  @ExceptionHandler(value = { AccessDeniedException.class })
- protected ResponseEntity<Object> handleAuthorizationErrors(Exception ex, WebRequest request) {
-
- LOGGER.error("Authorization error EXCETPION IS: " + ex.getClass().getName());
+ protected ResponseEntity<Object> handleAuthorizationErrors(AccessDeniedException ex) {
+ log.error("Authorization error EXCEPTION IS: {}", ex.getClass().getName());
  String message = "You are not authorized to access this resource.";
  validation.clear();
  return new ResponseEntity<>(ApiResponseModel.ERROR(null, message), HttpStatus.FORBIDDEN);
  }
 
  @ExceptionHandler(value = { GradBusinessRuleException.class })
- protected ResponseEntity<Object> handleGradBusinessException(Exception ex, WebRequest request) {
+ protected ResponseEntity<Object> handleGradBusinessException(GradBusinessRuleException ex) {
  ApiResponseModel<?> response = ApiResponseModel.ERROR(null);
- validation.ifErrors(errorList -> response.addErrorMessages(errorList));
- validation.ifWarnings(warningList -> response.addWarningMessages(warningList));
+ validation.ifErrors(response::addErrorMessages);
+ validation.ifWarnings(response::addWarningMessages);
  if (response.getMessages().isEmpty()) {
  response.addMessageItem(ex.getLocalizedMessage(), MessageTypeEnum.ERROR);
  }
@@ -66,55 +102,54 @@ protected ResponseEntity<Object> handleGradBusinessException(Exception ex, WebRe
  }
 
  @ExceptionHandler(value = { OptimisticEntityLockException.class })
- protected ResponseEntity<Object> handleOptimisticEntityLockException(OptimisticEntityLockException ex, WebRequest request) {
-
- LOGGER.error("EXCEPTION IS: " + ex.getClass().getName(), ex);
- LOGGER.error("Illegal argument ERROR IS: " + ex.getClass().getName(), ex);
- ApiResponseModel<?> response = ApiResponseModel.ERROR(null);
- validation.ifErrors(errorList -> response.addErrorMessages(errorList));
- validation.ifWarnings(warningList -> response.addWarningMessages(warningList));
- if (!validation.hasErrors()) {
- response.addMessageItem(ex.getLocalizedMessage(), MessageTypeEnum.ERROR);
- }
- validation.clear();
- return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
+ protected ResponseEntity<Object> handleOptimisticEntityLockException(OptimisticEntityLockException ex) {
+ return getGenericUncaughtExceptionResponse(ex);
  }
 
  @ExceptionHandler(value = { DataIntegrityViolationException.class })
- protected ResponseEntity<Object> handleSQLException(DataIntegrityViolationException ex, WebRequest request) {
+ protected ResponseEntity<Object> handleSQLException(DataIntegrityViolationException ex) {
 
- LOGGER.error("DATA INTEGRITY VIOLATION IS: " + ex.getClass().getName(), ex);
+ log.error("DATA INTEGRITY VIOLATION IS: {}", ex.getClass().getName(), ex);
  String msg = ex.getLocalizedMessage();
-
  Throwable cause = ex.getCause();
  if (cause instanceof ConstraintViolationException) {
  ConstraintViolationException contraintViolation = (ConstraintViolationException) cause;
  if ("23000".equals(contraintViolation.getSQLState())) {
  // primary key violation - probably inserting a duplicate record
- msg = ex.getRootCause().getMessage();
+ msg = (ex.getRootCause() != null) ? ex.getRootCause().getMessage() : "";
  }
  }
-
  ApiResponseModel<?> response = ApiResponseModel.ERROR(null, msg);
- validation.ifErrors(errorList -> response.addErrorMessages(errorList));
- validation.ifWarnings(warningList -> response.addWarningMessages(warningList));
+ validation.ifErrors(response::addErrorMessages);
+ validation.ifWarnings(response::addWarningMessages);
  validation.clear();
  return new ResponseEntity<>(response, HttpStatus.UNPROCESSABLE_ENTITY);
  }
 
  @ExceptionHandler(value = { Exception.class })
- protected ResponseEntity<Object> handleUncaughtException(Exception ex, WebRequest request) {
+ protected ResponseEntity<Object> handleUncaughtException(Exception ex) {
+ return getGenericUncaughtExceptionResponse(ex);
+ }
 
-  LOGGER.error("EXCEPTION IS: " + ex.getClass().getName(), ex);
- LOGGER.error("Illegal argument ERROR IS: " + ex.getClass().getName(), ex);
+ private ResponseEntity<Object> getGenericUncaughtExceptionResponse(Exception ex) {
+ log.error("EXCEPTION IS: {}", ex.getClass().getName(), ex);
  ApiResponseModel<?> response = ApiResponseModel.ERROR(null);
- validation.ifErrors(errorList -> response.addErrorMessages(errorList));
- validation.ifWarnings(warningList -> response.addWarningMessages(warningList));
+ validation.ifErrors(response::addErrorMessages);
+ validation.ifWarnings(response::addWarningMessages);
  if (!validation.hasErrors()) {
  response.addMessageItem(ex.getLocalizedMessage(), MessageTypeEnum.ERROR);
  }
  validation.clear();
  return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
  }
-
+
+ /**
+ * Build response entity response entity.
+ *
+ * @param apiError the api error
+ * @return the response entity
+ */
+ private ResponseEntity<Object> buildResponseEntity(ApiError apiError) {
+ return new ResponseEntity<>(apiError, apiError.getStatus());
+ }
 }