removed docker image push from all microservice projects, common redi…

…s configuration for polling-service functionalities, package restructuring for polling-service, added readme and architecture diagram of project

README.md

@@ -0,0 +1,97 @@
+SHARE NOW - JAVA CODING CHALLENGE
+---
+### TECHNOLOGY STACK
+| Technology | Implementations/Frameworks | Version | Purpose |
+| ----------- | ----------- | ----------- | ----------- |
+| Java | Hotspot VM | 11 | JVM |
+| Java | Spring Boot | 2.3.x | REST API framework |
+| Java | Spring Cloud | Hoxton | Microservice framework|
+| Java | Java Topology Suite | 1.14 | Geometric algorithms |
+| Java | Open Zipkin |  2.23.3-SNAPSHOT | Distributed tracing |
+| Java | JUnit | 5 | Unit testing |
+| Java | Maven | 3.6.x | Build artifacts and execute tests |
+| NoSQL | Redis | 3.0.x | Data caching for fast reads |
+| NoSQL | MongoDB | 4.4 | Data store for nested schema |
+| Virtualization | Docker | 20.10.5 | Platform agnostic containerization |
+| OpenAPI | Swagger | 2 | REST API Documentation |
+---
+### MINIMUM SYSTEM REQUIREMENTS
+1. Disk - 4 GB
+2. Memory - 3 GB
+3. Processor - 2 CPU
+4. Network - 80 MBps
+5. Operating System - Ubuntu 20.4 or Windows 10
+6. JDK - 11
+7. Maven - 3.6.x
+8. Docker - 20.10.x
+9. Docker Compose - 1.28.x
+---
+### STEPS TO RUN
+1. Open terminal or command prompt
+2. Move to the root folder containing all the projects (source code for services) viz., `sharenow-coding-challenge`
+3. Execute `mvn clean package -e` at the root folder containing all the projects to download dependencies, build the artifacts and create respective docker images
+4. Execute `docker-compose up` at the root folder containing all the projects to start the entire microservice ecosystem
+5. Browse to `http://<HOST_SYSTEM-IP>:8761` in a browser to see if the all the services are available in EUREKA server or not
+6. Access the Swagger documentation of individual core microservices viz., car, polygon, position to execute requests as desired over `http://<HOST-SYSTEM-IP>:8081/<SERVICE-NAME>/<SERVICE-CONTEXT-PATH>/swagger-ui/`
+---
+### ARCHITECTURE
+[Click here to see](https://i.ibb.co/R0dzhpT/sharenow-coding-challenge-architecture.png)
+![Click here to see](./scripts/sharenow-coding-challenge-architecture.png)
+---
+### FEATURES
+1. Search for a car by its VIN and receive the strategic polygon details that it is currently present at
+1. Search for a strategic polygon by its id or name and receive all the cars that it contains
+---
+### PROJECT DESCRIPTION
+| SERVICE NAME | FUNCTIONALITY | TYPE |
+| ----------- | ----------- | ----------- |
+| configuration-service | Centralized configuration store for all microservices | Maven Project |
+| naming-service | Service registration and discovery for all microservices by their name| Maven Project |
+| gateway-service | Single entry point to provided accessibility for all microservices by their API, routes request to appropriate microservices | Maven Project |
+| polling-service | Periodically refreshes live car locations for Stuttgart and puts them into the cache, Evicts cars using a custom least recently updated eviction policy | Maven Project |
+| car-service | Query for cars and their details from cache for Stuttgart | Maven Project |
+| polygon-service | Query strategic polygons and their details for Stuttgart | Maven Project |
+| position-service | Maps cars to its enclosing strategic polygon using its vin, Collects all cars present within a strategic polygon by its id | Maven Project |
+| cache-service | Stores live data for cars from Stuttgart and evicts data having TTL set against its key | Docker Image 
+| documentdb-store | Stores strategic polygons for Stuttgart and their details | Docker Image 
+| tracing-service | Trace requests across microservices for debugging | Docker Image 
+| car2godeveloper-service | Provides live locations of cars in Stuttgart | Docker Image |
+---
+### ASSUMPTIONS
+1. All business logic is written specifically for Stuttgart
+2. No two strategic polygon intersects
+3. Any car on the edge of a strategic polygon's boundary, will be considered within the polygon
+4. polling-service is expected to be a daemon service that is concerned with writing to a data store only, hence it doesn't need horizontal scaling but rather vertical scaling if at all required to be more performant
+5. JAVA_HOME and MAVEN_HOME is set on the host system
+6. car2godeveloper/api-for-coding-challenge has been treated as a black box with only documentation available to use it as required
+---
+### DECISIONS
+1. Cars can be queried either by their VIN or all the ones currently available at once
+2. Strategic polygons can be queried by their id or name or all available ones at once
+3. A car that is not within any of the strategic polygon will be deemed as unavailable
+4. A strategic polygon will report no cars available if it can't place any car within itself at any given point in time
+5. All other services except for polling-service should scale horizontally to keep up with dynamic load in favour of being high performant
+6. Swagger has only been enabled for services that define the core business logic viz., car, polygon, position
+7. Unit tests have been written to assert the business logic of core microservices viz., car, polygon, position 
+8. polling-service is intended to be write intrinsic while car-service is intended to be read intrinsic through a distributed workflow spanning across two microservices and integrated using a cache (redis). This has been done to avoid bottle-neck and any single point of failure.
+---
+### REST API DOCUMENTATION
+| SERVICE-NAME | API DOCUMENTATION URL |
+| ----------- | ----------- |
+| car-service | http://<GATWAY-SERVICE-IP>:8081/car-service/car/swagger-ui/) |
+| polygon-service | http://<GATWAY-SERVICE-IP>:8081/polygon-service/polygon/swagger-ui/) |
+| position-service | http://<GATWAY-SERVICE-IP>:8081/position-service/position/swagger-ui/) |
+---
+### ISSUES/ENHANCEMENTS
+1. Implement custom health indicators
+2. Enforce strict depends on strategy in docker-compose during container creation using custom service health checks for graceful startup
+3. Implement circuit breaker
+4. Implement strategic polygon search by name for positioning
+5. Implement file system configuration store
+6. Enable security on all microservices
+7. Enable authentication of cache and document database
+8. Encrypt security credentials in configuration store
+9. Redis should be configured for master-slave where master is write concern and all slaves are read concerns with eventual consistency between them 
+---
+### ADDITIONAL RESOURCES
+In the `scripts` folder under the root folder `sharenow-coding-challenge` you will find the postman collection corresponding to all the REST APIS defined for each microservice in this entire project. You can use it as well if needed.

car-service/pom.xml

@@ -30,7 +30,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

configuration-service/pom.xml

@@ -26,7 +26,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

gateway-service/pom.xml

@@ -26,7 +26,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

naming-service/pom.xml

@@ -37,7 +37,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

polling-service/pom.xml

@@ -26,7 +26,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/cleanup/configuration/VehicleCleanupConfiguration.java

@@ -3,17 +3,16 @@
 import io.lettuce.core.RedisClient;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
-import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
-import org.springframework.stereotype.Component;
+import org.springframework.context.annotation.Configuration;
 
-@Component
+@Configuration
 public class VehicleCleanupConfiguration {
 
 
-    @Bean
+    /*@Bean
     public LettuceConnectionFactory lettuceConnectionFactory() {
         return new LettuceConnectionFactory();
-    }
+    }*/
 
     @Bean
     public RedisClient lettuceClient(@Value("${spring.redis.host}") String redisHost, @Value("${spring.redis.port}") int redisPort) {

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/cleanup/service/impl/Car2GoCarCleanupServiceImpl.java

@@ -1,6 +1,6 @@
 package com.teenthofabud.codingchallenge.sharenow.polling.cleanup.service.impl;
 
-import com.teenthofabud.codingchallenge.sharenow.polling.PollingMonitor;
+import com.teenthofabud.codingchallenge.sharenow.polling.configuration.PollingMonitor;
 import com.teenthofabud.codingchallenge.sharenow.polling.cleanup.service.CarCleanupService;
 import com.teenthofabud.codingchallenge.sharenow.polling.cleanup.service.CarStaleness;
 import com.teenthofabud.codingchallenge.sharenow.polling.model.entity.CarEntity;

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/PollingMonitor.java → polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/configuration/PollingMonitor.java

@@ -1,4 +1,4 @@
-package com.teenthofabud.codingchallenge.sharenow.polling;
+package com.teenthofabud.codingchallenge.sharenow.polling.configuration;
 
 import org.springframework.stereotype.Component;
 

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/configuration/PollingServiceConfiguration.java

@@ -0,0 +1,16 @@
+package com.teenthofabud.codingchallenge.sharenow.polling.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
+
+@Configuration
+public class PollingServiceConfiguration {
+
+    @Bean
+    public RedisConnectionFactory redisConnectionFactory() {
+        return new LettuceConnectionFactory();
+    }
+
+}

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/refresh/configuration/CarRefreshConfiguration.java

@@ -2,20 +2,20 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.data.redis.core.RedisTemplate;
-import org.springframework.stereotype.Component;
 
-@Component
+@Configuration
 public class CarRefreshConfiguration {
 
     @Autowired
-    private RedisConnectionFactory connectionFactory;
+    private RedisConnectionFactory redisConnectionFactory;
 
     @Bean
     public RedisTemplate<?, ?> redisTemplate() {
         RedisTemplate<byte[], byte[]> template = new RedisTemplate<byte[], byte[]>();
-        template.setConnectionFactory(connectionFactory);
+        template.setConnectionFactory(redisConnectionFactory);
         return template;
     }
 

polling-service/src/main/java/com/teenthofabud/codingchallenge/sharenow/polling/refresh/service/impl/Car2GoCarRefreshServiceImpl.java

@@ -1,7 +1,7 @@
 package com.teenthofabud.codingchallenge.sharenow.polling.refresh.service.impl;
 
 
-import com.teenthofabud.codingchallenge.sharenow.polling.PollingMonitor;
+import com.teenthofabud.codingchallenge.sharenow.polling.configuration.PollingMonitor;
 import com.teenthofabud.codingchallenge.sharenow.polling.model.dto.CarDTO;
 import com.teenthofabud.codingchallenge.sharenow.polling.model.entity.PositionEntity;
 import com.teenthofabud.codingchallenge.sharenow.polling.model.entity.CarEntity;

polygon-service/pom.xml

@@ -30,7 +30,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>

position-service/pom.xml

@@ -75,7 +75,6 @@
                         <id>default</id>
                         <goals>
                             <goal>build</goal>
-                            <goal>push</goal>
                         </goals>
                     </execution>
                 </executions>