Adding API gateway

- All test cases runs for the whole system.
- Reduce application.yml properties
- add new system diagram.
- Update README.md.

Author: mohamed-taman

README.md

@@ -28,7 +28,8 @@ Springy Store μService --> Parent folder.
   |- store-cloud-chassis --> Cloud services Parent POM, inherit from build contains all cloud libraries 
   |- store-service-chassis --> Parent POM, inherits from cloud contains all microservices common libraries 
 |-store-cloud-infra 
-  |- eureka-server --> Service discovery server 
+  |- eureka-server --> Service discovery server
+  |- edge-server --> API Gateway server 
 |-store-common 
   |- store-api --> API Endpoint and services definitions for all microservices 
   |- store-utils --> Common utilities shared between all components 
@@ -66,7 +67,7 @@ The following topics are going to be covered in this 1st stage (other stages top
 - Adding automated tests of microservices in isolation.
 - Adding semi-automated tests to a microservice landscape.
 
-### System Boundary - μServices Landscape (Release 4.5-Latest)
+### System Boundary - μServices Landscape (Release 4.8-Latest)
 
 ![System Boundary](docs/stage1/app_ms_landscape.png)
 
@@ -158,7 +159,7 @@ All build commands and test suite for each microservice should run successfully,
 
 ```bash
 ---------------< com.siriusxi.ms.store:store-aggregator >---------------
-[INFO] Building Springy Store Aggregator 1.0-SNAPSHOT                   [11/11]
+[INFO] Building Springy Store Aggregator 1.0-SNAPSHOT                   [12/12]
 [INFO] --------------------------------[ pom ]---------------------------------
 [INFO]
 [INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ store-aggregator ---
@@ -175,6 +176,7 @@ All build commands and test suite for each microservice should run successfully,
 [INFO] Recommendation Service ............................. SUCCESS [  8.463 s]
 [INFO] Store Service ...................................... SUCCESS [  8.927 s]
 [INFO] Eureka Discovery Server ............................ SUCCESS [  6.536 s]
+[INFO] Edge Server ........................................ SUCCESS [ 32.108 s]
 [INFO] Springy Store Aggregator ........................... SUCCESS [  0.100 s]
 [INFO] ------------------------------------------------------------------------
 [INFO] BUILD SUCCESS
@@ -198,6 +200,7 @@ All the **services**, **databases**, and **messaging service** will run in paral
 ```bash
 Creating network "ssm_default" with the default driver
 Creating ssm_eureka_1         ... done
+Creating ssm_gateway_1        ... done
 Creating ssm_mysql_1          ... done
 Creating ssm_mongodb_1        ... done
 Creating ssm_rabbitmq_1       ... done
@@ -235,7 +238,7 @@ This will result in the following response:
 {
    "status":"UP",
     "components":{
-      "Core System Microservices":{
+      "System Microservices":{
          "status":"UP",
          "components":{
             "Product Service":{
@@ -278,7 +281,7 @@ The result will look like this:
 ```bash
 Starting [Springy Store] full functionality testing....
 
-Start: Sun, Apr 12, 2020 2:34:19 PM
+Start: Sun, Apr 30, 2020 2:34:19 PM
 HOST=localhost
 PORT=8080
 Wait for: curl http://localhost:8080/actuator/health ... Ok
@@ -302,13 +305,13 @@ Test OK (HTTP Code: 422, {"httpStatus":"UNPROCESSABLE_ENTITY","message":"Invalid
 Test OK (actual value: "Invalid productId: -1")
 Test OK (HTTP Code: 400, {"timestamp":"2020-04-12T12:34:26.471+00:00","path":"/store/api/v1/products/invalidProductId","status":400,"error":"Bad Request","message":"Type mismatch.","requestId":"044dcdf2-13"})
 Test OK (actual value: "Type mismatch.")
-End: Sun, Apr 12, 2020 2:34:26 PM
+End: Sun, Apr 30, 2020 2:34:26 PM
 ```
 
 ### Closing The Story
 
-Finally, to close the story, we will need to shut down Microservices manually service by service
-, hahaha just kidding, run the following script to shut down them all:
+Finally, to close the story, we need to shut down Microservices manually service by service
+, hahaha just kidding, run the following command to shut them all:
 
 ```bash
 mohamed.taman@DTLNV8 ~/springy-store-microservices 
@@ -326,6 +329,7 @@ Stopping ssm_store_1          ... done
 Stopping ssm_mysql_1          ... done
 Stopping ssm_rabbitmq_1       ... done
 Stopping ssm_eureka_1         ... done
+Stopping ssm_gateway_1        ... done
 Removing ssm_recommendation_1 ... done
 Removing ssm_product_1        ... done
 Removing ssm_review_1         ... done
@@ -334,11 +338,11 @@ Removing ssm_store_1          ... done
 Removing ssm_mysql_1          ... done
 Removing ssm_rabbitmq_1       ... done
 Removing ssm_eureka_1         ... done
+Removing ssm_gateway_1        ... done
 Removing network ssm_default
 ```
 ### The End
 Happy coding :)
 
 # License
-Copyright (C) 2017-2020 Mohamed Taman
-Licensed under the MIT License.
+Copyright (C) 2017-2020 Mohamed Taman, Licensed under the MIT License.

docker-compose-kafka.yml

@@ -119,6 +119,16 @@ services:
       - "8761:8761"
     restart: always
   ## End - Eureka Service Discovery definition
+
+  ## Start - Edge Server definition
+  gateway:
+    build: store-cloud-infra/edge-server
+    ports:
+      - "8080:8080"
+    environment:
+      - SPRING_PROFILES_ACTIVE=docker
+    restart: on-failure
+  ## End - Edge Server definition
   # End - Cloud Infrastructure
 
   # Start - Data and transport Infrastructure

docker-compose-partitions.yml

@@ -105,6 +105,16 @@ services:
       - "8761:8761"
     restart: always
   ## End - Eureka Service Discovery definition
+
+  ## Start - Edge Server definition
+  gateway:
+    build: store-cloud-infra/edge-server
+    ports:
+      - "8080:8080"
+    environment:
+      - SPRING_PROFILES_ACTIVE=docker
+    restart: on-failure
+  ## End - Edge Server definition
   # End - Cloud Infrastructure
 
   # Start - Data and transport Infrastructure

docker-compose.yml

@@ -53,6 +53,16 @@ services:
       - "8761:8761"
     restart: on-failure
   ## End - Eureka Service Discovery definition
+
+  ## Start - Edge Server definition
+  gateway:
+    build: store-cloud-infra/edge-server
+    ports:
+      - "8080:8080"
+    environment:
+      - SPRING_PROFILES_ACTIVE=docker
+    restart: on-failure
+  ## End - Edge Server definition
   # End - Cloud Infrastructure
 
   # Start - Data and transport Infrastructure

docs/stage1/app_ms_landscape.png

@@ -27,6 +27,7 @@
         <module>store-services/recommendation-service</module>
         <module>store-services/store-service</module>
         <module>store-cloud-infra/eureka-server</module>
+        <module>store-cloud-infra/edge-server</module>
 
 
     </modules>

pom.xml

@@ -16,6 +16,14 @@
 	<packaging>pom</packaging>
 
 	<dependencies>
+		<!-- Start - Core spring dependencies -->
+		<!-- Start - Providing some useful infos about the service through REST API -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
+		<!-- End - Providing some useful infos about the service through REST API -->
+		<!-- Start - Cloud dependencies -->
 		<!-- Start - Testing dependencies -->
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

store-base/store-cloud-chassis/pom.xml

@@ -17,14 +17,6 @@
     <packaging>pom</packaging>
 
     <dependencies>
-        <!-- Start - Core spring dependencies -->
-        <!-- Start - Providing some useful infos about the service through REST API -->
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-actuator</artifactId>
-        </dependency>
-        <!-- End - Providing some useful infos about the service through REST API -->
-        <!-- Start - Cloud dependencies -->
         <!-- Start - Spring Stream processing using "RabbitMQ massaging" -->
         <dependency>
             <groupId>org.springframework.cloud</groupId>

store-base/store-service-chassis/pom.xml

@@ -0,0 +1,60 @@
+#### Start of builder image
+# ------------------------
+# Builder stage to prepare application for final image
+FROM openjdk:14-slim-buster as builder
+WORKDIR temp
+
+# Fatjar location, but could be set to different location from command line
+ARG JAR_FILE=target/*.jar
+
+# Copy fat jar file to current image builder
+COPY ${JAR_FILE} application.jar
+
+# Extract the jar file layers
+RUN java -Djarmode=layertools -jar --enable-preview application.jar extract
+
+# Workaround to avoid Copy command failure when directory is not exists.
+RUN test ! -d ./snapshot-dependencies \
+&& mkdir snapshot-dependencies \
+&& echo "Directory [snapshot-dependencies] created."
+
+#### End of builder stage
+
+#### Start of actual image
+# ------------------------
+# Build image based on JDK 14 base image, based on latest debian buster OS
+FROM openjdk:14-slim-buster
+VOLUME /tmp
+
+# Set image information, but could be set to different location from command line
+ARG IMAGE_VERSION="1.0-SNAPSHOT"
+ARG IMAGE_NAME="Edge Server"
+ARG MAINTAINER="Mohamed Taman <mohamed.taman@gmail.com>"
+
+LABEL version=${IMAGE_VERSION} name=${IMAGE_NAME} maintainer=${MAINTAINER}
+
+# Limiting security access to not user root user
+RUN addgroup siriusxi && useradd -g siriusxi -ms /bin/bash taman
+
+# Setting user to current created user
+USER taman
+
+# Set working directory to application folder
+WORKDIR /home/taman/application
+
+# Copy all layers from builder stage to current image
+COPY --from=builder temp/dependencies/ ./
+COPY --from=builder temp/snapshot-dependencies/ ./
+COPY --from=builder temp/spring-boot-loader/ ./
+COPY --from=builder temp/application/ ./
+
+# Expose current server to port 8080
+EXPOSE 8761
+
+ARG JAVA_OPTS=""
+
+# Run the application with JVM configs if any
+ENTRYPOINT ["bash", "-c", \
+"java -server --enable-preview -XX:+UseContainerSupport -XX:+ShowCodeDetailsInExceptionMessages \
+-XX:+AlwaysActAsServerClassMachine -XX:+UseG1GC -XX:+UseStringDeduplication ${JAVA_OPTS} \
+org.springframework.boot.loader.JarLauncher ${0} ${@}"]

store-cloud-infra/edge-server/Dockerfile

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>com.siriusxi.ms.store</groupId>
+		<artifactId>store-cloud-chassis</artifactId>
+		<version>1.0-SNAPSHOT</version>
+		<relativePath>../store-base/store-cloud-chassis</relativePath>
+	</parent>
+
+	<groupId>com.siriusxi.cloud.infra</groupId>
+	<artifactId>gateway</artifactId>
+	<version>1.0-SNAPSHOT</version>
+	<name>Edge Server</name>
+	<description>Spring Cloud API Gateway Server, based on Spring boot.</description>
+	<packaging>jar</packaging>
+
+	<dependencies>
+		<!-- Start - Spring cloud API Gateway server -->
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-starter-gateway</artifactId>
+		</dependency>
+		<!-- End - Spring cloud API Gateway server -->
+		<!-- Start - To register API Gateway server with Eureka Discovery Server -->
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
+		</dependency>
+		<!-- End - To register API Gateway server with Eureka Discovery Server -->
+		<!-- Start - Javax.validation is required to in order to test to work -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-validation</artifactId>
+			<scope>runtime</scope>
+		</dependency>
+		<!-- End - Javax.validation is required to in order to test to work -->
+	</dependencies>
+
+</project>

store-cloud-infra/edge-server/pom.xml

@@ -0,0 +1,22 @@
+package com.siriusxi.cloud.infra.gateway;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.loadbalancer.LoadBalanced;
+import org.springframework.context.annotation.Bean;
+import org.springframework.web.reactive.function.client.WebClient;
+
+@SpringBootApplication
+public class EdgeServerApplication {
+
+	@Bean
+	@LoadBalanced
+	public WebClient.Builder loadBalancedWebClientBuilder() {
+		return WebClient.builder();
+	}
+
+	public static void main(String[] args) {
+		SpringApplication.run(EdgeServerApplication.class, args);
+	}
+
+}

store-cloud-infra/edge-server/src/main/java/com/siriusxi/cloud/infra/gateway/EdgeServerApplication.java

@@ -0,0 +1,73 @@
+package com.siriusxi.cloud.infra.gateway.config;
+
+import lombok.extern.log4j.Log4j2;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.health.CompositeReactiveHealthContributor;
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.boot.actuate.health.ReactiveHealthContributor;
+import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.reactive.function.client.WebClient;
+import reactor.core.publisher.Mono;
+
+import java.util.Map;
+
+@Configuration
+@Log4j2
+public class GatewayConfiguration {
+
+  private final WebClient.Builder webClientBuilder;
+
+  private WebClient webClient;
+
+  @Autowired
+  public GatewayConfiguration(WebClient.Builder webClientBuilder) {
+    this.webClientBuilder = webClientBuilder;
+  }
+
+    /**
+     * This method is to check all the services health status, and Gateway service health will be
+     * only in up health state if and only if all of the core services and dependencies are up
+     * and running.
+     *
+     * @return ReactiveHealthContributor information about all the core microservices.
+     */
+    @Bean(name = "Core Microservices")
+    ReactiveHealthContributor coreServices() {
+
+        ReactiveHealthIndicator productHealthIndicator = () -> getServicesHealth("http://product");
+        ReactiveHealthIndicator recommendationHealthIndicator = () -> getServicesHealth("http://recommendation");
+        ReactiveHealthIndicator reviewHealthIndicator = () -> getServicesHealth("http://review");
+        ReactiveHealthIndicator storeHealthIndicator = () -> getServicesHealth("http://store");
+
+        Map<String, ReactiveHealthContributor> allIndicators =
+                Map.of(
+                        "Product Service", productHealthIndicator,
+                        "Recommendation Service", recommendationHealthIndicator,
+                        "Review Service", reviewHealthIndicator,
+                        "Store Service",storeHealthIndicator);
+
+        return CompositeReactiveHealthContributor.fromMap(allIndicators);
+    }
+
+  private Mono<Health> getServicesHealth(String url) {
+    url += "/actuator/health";
+    log.debug("Will call the Health API on URL: {}", url);
+    return getWebClient()
+        .get()
+        .uri(url)
+        .retrieve()
+        .bodyToMono(String.class)
+        .map(s -> new Health.Builder().up().build())
+        .onErrorResume(ex -> Mono.just(new Health.Builder().down(ex).build()))
+        .log();
+  }
+
+  private WebClient getWebClient() {
+    if (webClient == null) {
+      webClient = webClientBuilder.build();
+    }
+    return webClient;
+  }
+}