Merge pull request #45 from Preponderous-Software/pr/address-comments-on-pr-37

Pr/address comments on pr 37

Author: dmccoystephenson

compose.yml

@@ -8,9 +8,9 @@ services:
     ports:
       - "5432:5432"
     environment:
-      POSTGRES_USER: ${DB_USERNAME}
-      POSTGRES_PASSWORD: ${DB_PASSWORD}
-      POSTGRES_DB: ${DB_NAME}
+      POSTGRES_USER: ${DATABASE_DB_USERNAME}
+      POSTGRES_PASSWORD: ${DATABASE_DB_PASSWORD}
+      POSTGRES_DB: ${DATABASE_DB_NAME}
     volumes:
       - postgres_data:/var/lib/postgresql/data
       - ./db-scripts/setup:/docker-entrypoint-initdb.d
@@ -21,9 +21,11 @@ services:
     ports:
       - "9999:9999"
     environment:
-      CONFIG_DB_URL: jdbc:postgresql://${DB_HOST}:${DB_PORT}/${DB_NAME}
-      CONFIG_DB_USERNAME: ${DB_USERNAME}
-      CONFIG_DB_PASSWORD: ${DB_PASSWORD}
+      DATABASE_DB_URL: jdbc:postgresql://${DATABASE_DB_HOST}:${DATABASE_DB_PORT}/${DATABASE_DB_NAME}
+      DATABASE_DB_USERNAME: ${DATABASE_DB_USERNAME}
+      DATABASE_DB_PASSWORD: ${DATABASE_DB_PASSWORD}
+      SERVICE_VIRON_HOST: ${SERVICE_VIRON_HOST}
+      SERVICE_VIRON_PORT: ${SERVICE_VIRON_PORT}
     depends_on:
       - postgres
 

pom.xml

@@ -44,16 +44,15 @@
             <version>1.18.30</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
             <version>2.3.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

sample.env

@@ -1,9 +1,17 @@
 # Copyright (c) 2024 Preponderous Software
 # MIT License
 
+# GENERAL
+SPRING_APPLICATION_NAME=viron
+SERVER_PORT=9999
+
 # postgres
-DB_HOST=postgres
-DB_PORT=5432
-DB_NAME=postgres
-DB_USERNAME=postgres
-DB_PASSWORD=postgres
+DATABASE_DB_HOST=postgres
+DATABASE_DB_PORT=5432
+DATABASE_DB_NAME=postgres
+DATABASE_DB_USERNAME=postgres
+DATABASE_DB_PASSWORD=postgres
+
+# service
+SERVICE_VIRON_HOST=http://localhost
+SERVICE_VIRON_PORT=9999

src/main/java/preponderous/viron/config/DbConfig.java

@@ -10,7 +10,7 @@
 
 @Setter
 @Getter
-@ConfigurationProperties("config")
+@ConfigurationProperties("database")
 @PropertySource("classpath:application.properties")
 public class DbConfig {
     private String dbUrl;

src/main/java/preponderous/viron/config/ServiceConfig.java

@@ -7,7 +7,7 @@
 
 @Setter
 @Getter
-@ConfigurationProperties("config")
+@ConfigurationProperties("service")
 @PropertySource("classpath:application.properties")
 public class ServiceConfig {
     private String vironHost;

src/main/java/preponderous/viron/controllers/DebugController.java

@@ -4,6 +4,7 @@
 import java.util.Arrays;
 import java.util.List;
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -22,6 +23,7 @@
 
 @RestController
 @RequestMapping("/api/v1/debug")
+@Slf4j
 public class DebugController {
     private final EntityService entityService;
     private final EnvironmentService environmentService;
@@ -37,19 +39,12 @@ public DebugController(EntityService entityService, EnvironmentService environme
         this.locationService = locationService;
     }
 
-    @GetMapping("/health-check")
-    public String healthCheck() {
-        return "OK";
-    }
-
     /**
      * Creates a sample environment with a single 10x10 grid and places ten entities in random, valid locations within the grid.
      * It ensures the entities are properly created and assigned to valid locations in the grid.
-     *
-     * @return a ResponseEntity containing a Boolean value, true if the sample data was created successfully, false otherwise.
      */
     @PostMapping("/create-sample-data")
-    public ResponseEntity<Boolean> createSampleData() {
+    public ResponseEntity<Environment> createSampleData() {
         // create an environment with one 10x10 grid
         Environment environment = environmentService.createEnvironment("Sample Environment", 1, 10);
         List<Grid> grids = gridService.getGridsInEnvironment(environment.getEnvironmentId());
@@ -64,46 +59,44 @@ public ResponseEntity<Boolean> createSampleData() {
             int x = (int) (Math.random() * grid.getRows());
             int y = (int) (Math.random() * grid.getColumns());
             Location location = null;
-            for (int j = 0; j < locations.size(); j++) {
-                if (locations.get(j).getX() == x && locations.get(j).getY() == y) {
-                    location = locations.get(j);
+            for (Location value : locations) {
+                if (value.getX() == x && value.getY() == y) {
+                    location = value;
                     break;
                 }
             }
             if (location == null) {
-                return ResponseEntity.ok(false);
+                return ResponseEntity.badRequest().body(null); // exit if no valid location found
             }
             locationService.addEntityToLocation(entity.getEntityId(), location.getLocationId());
         }
 
-        return ResponseEntity.ok(true);
+        return ResponseEntity.ok(environment);
     }
 
     /**
      * Creates an environment with a single grid of fixed size, generates a random entity,
      * and places the entity at a random valid location within the grid.
      *
      * @param environmentName the name of the environment to be created
-     * @return a ResponseEntity containing a Boolean value, true if the entity was successfully created
-     *         and placed in a location, false if the operation failed
      */
     @PostMapping("/create-world-and-place-entity/{environmentName}")
-    public ResponseEntity<Boolean> createWorldAndPlaceEntity(@PathVariable String environmentName) {
+    public ResponseEntity<Entity> createWorldAndPlaceEntity(@PathVariable String environmentName) {
         // create an environment
         int numGrids = 1;
         int gridSize = 5;
         Environment environment = environmentService.createEnvironment(environmentName, numGrids, gridSize);
-        System.out.println("Environment created: " + environment.getName());
+        log.info("Environment created: {} with ID {}", environment.getName(), environment.getEnvironmentId());
 
         // get grid info
         List<Grid> grids = gridService.getGridsInEnvironment(environment.getEnvironmentId());
         Grid grid = grids.get(0);
-        System.out.println("Grid in environment has " + grid.getRows() + " rows and " + grid.getColumns() + " columns");
+        log.info("Grid created: {} with size {}x{}", grid.getGridId(), grid.getRows(), grid.getColumns());
 
         // create an entity
         String entityName = entityNamePool.get((int) (Math.random() * entityNamePool.size()));
         Entity entity = entityService.createEntity(entityName);
-        System.out.println("Entity created: " + entity.getName());
+        log.info("Entity created: {}", entity.getName());
 
         // place entity in grid
         int entityRow = (int) (Math.random() * grid.getRows());
@@ -117,11 +110,11 @@ public ResponseEntity<Boolean> createWorldAndPlaceEntity(@PathVariable String en
             }
         }
         if (location == null) {
-            // exit
-            System.out.println("Location not found. Exiting...");
+            log.error("No valid location found for entity at row {} and column {}", entityRow, entityColumn);
+            return ResponseEntity.badRequest().body(null);
         }
         locationService.addEntityToLocation(entity.getEntityId(), location.getLocationId());
-        System.out.println("Entity placed in grid at row " + entityRow + " and column " + entityColumn);
-        return ResponseEntity.ok(true);
+        log.info("Entity {} placed at location ({}, {})", entity.getName(), entityRow, entityColumn);
+        return ResponseEntity.ok(entity);
     }
 }

src/main/java/preponderous/viron/exceptions/EntityServiceException.java

@@ -1,6 +1,6 @@
 package preponderous.viron.exceptions;
 
-public class EntityServiceException extends RuntimeException {
+public class EntityServiceException extends ServiceException {
     public EntityServiceException(String message) {
         super(message);
     }

src/main/java/preponderous/viron/exceptions/NotFoundException.java

@@ -1,6 +1,6 @@
 package preponderous.viron.exceptions;
 
-public class NotFoundException extends RuntimeException {
+public class NotFoundException extends ServiceException {
     public NotFoundException(String message) {
         super(message);
     }

src/main/java/preponderous/viron/services/EnvironmentService.java

@@ -14,6 +14,7 @@
 import org.springframework.web.client.RestTemplate;
 
 import preponderous.viron.config.ServiceConfig;
+import preponderous.viron.exceptions.ServiceException;
 import preponderous.viron.models.Environment;
 
 @Service
@@ -33,7 +34,7 @@ public List<Environment> getAllEnvironments() {
         RestTemplate restTemplate = restTemplateBuilder.build();
         ResponseEntity<Environment[]> response = restTemplate.exchange(baseUrl, HttpMethod.GET, null, Environment[].class);
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error getting environments");
+            throw new ServiceException("Error getting environments");
         }
         return Arrays.asList(response.getBody());
     }
@@ -42,7 +43,7 @@ public Environment getEnvironmentById(int id) {
         RestTemplate restTemplate = restTemplateBuilder.build();
         ResponseEntity<Environment> response = restTemplate.exchange(baseUrl + "/{id}", HttpMethod.GET, null, Environment.class, id);
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error getting environment by id");
+            throw new ServiceException("Error getting environment by id");
         }
         return response.getBody();
     }
@@ -51,7 +52,7 @@ public Environment getEnvironmentByName(String name) {
         RestTemplate restTemplate = restTemplateBuilder.build();
         ResponseEntity<Environment> response = restTemplate.exchange(baseUrl + "/name/{name}", HttpMethod.GET, null, Environment.class, name);
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error getting environment by name");
+            throw new ServiceException("Error getting environment by name");
         }
         return response.getBody();
     }
@@ -60,7 +61,7 @@ public Environment getEnvironmentOfEntity(int entityId) {
         RestTemplate restTemplate = restTemplateBuilder.build();
         ResponseEntity<Environment> response = restTemplate.exchange(baseUrl + "/entity/{entityId}", HttpMethod.GET, null, Environment.class, entityId);
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error getting environment of entity");
+            throw new ServiceException("Error getting environment of entity");
         }
         return response.getBody();
     }
@@ -77,7 +78,7 @@ public Environment createEnvironment(String name, int numGrids, int gridSize) {
                 gridSize
         );
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error creating environment");
+            throw new ServiceException("Error creating environment");
         }
         return response.getBody();
     }
@@ -86,7 +87,7 @@ public boolean deleteEnvironment(int id) {
         RestTemplate restTemplate = restTemplateBuilder.build();
         ResponseEntity<Void> response = restTemplate.exchange(baseUrl + "/{id}", HttpMethod.DELETE, null, Void.class, id);
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error deleting environment");
+            throw new ServiceException("Error deleting environment");
         }
         return response.getStatusCode().is2xxSuccessful();
     }
@@ -102,7 +103,7 @@ public boolean updateEnvironmentName(int id, String name) {
                 name
         );
         if (response.getStatusCode().isError()) {
-            throw new RuntimeException("Error updating environment name");
+            throw new ServiceException("Error updating environment name");
         }
         return response.getStatusCode().is2xxSuccessful();
     }

src/main/java/preponderous/viron/services/GridService.java

@@ -9,6 +9,7 @@
 import org.springframework.web.client.HttpClientErrorException;
 import org.springframework.web.client.RestTemplate;
 import preponderous.viron.config.ServiceConfig;
+import preponderous.viron.exceptions.ServiceException;
 import preponderous.viron.models.Grid;
 
 import java.util.Arrays;
@@ -34,7 +35,7 @@ public List<Grid> getAllGrids() {
             return Arrays.asList(response.getBody());
         } catch (Exception e) {
             log.error("Error getting all grids: {}", e.getMessage());
-            throw new RuntimeException("Failed to fetch all grids", e);
+            throw new ServiceException("Failed to fetch all grids", e);
         }
     }
 
@@ -47,7 +48,7 @@ public Optional<Grid> getGridById(int id) {
             return Optional.empty();
         } catch (Exception e) {
             log.error("Error getting grid by id {}: {}", id, e.getMessage());
-            throw new RuntimeException("Failed to fetch grid by id: " + id, e);
+            throw new ServiceException("Failed to fetch grid by id: " + id, e);
         }
     }
 
@@ -62,7 +63,7 @@ public List<Grid> getGridsInEnvironment(int environmentId) {
             return Arrays.asList(response.getBody());
         } catch (Exception e) {
             log.error("Error getting grids in environment {}: {}", environmentId, e.getMessage());
-            throw new RuntimeException("Failed to fetch grids in environment: " + environmentId, e);
+            throw new ServiceException("Failed to fetch grids in environment: " + environmentId, e);
         }
     }
 
@@ -79,7 +80,7 @@ public Optional<Grid> getGridOfEntity(int entityId) {
             return Optional.empty();
         } catch (Exception e) {
             log.error("Error getting grid for entity {}: {}", entityId, e.getMessage());
-            throw new RuntimeException("Failed to fetch grid for entity: " + entityId, e);
+            throw new ServiceException("Failed to fetch grid for entity: " + entityId, e);
         }
     }
 }

src/main/python/preponderous/viron/services/locationService.py

@@ -15,31 +15,31 @@ def get_base_url(self) -> str:
     def get_all_locations(self) -> List[Location]:
         response = requests.get(self.get_base_url())
         response.raise_for_status()
-        return response.json()
+        return [Location(**loc) for loc in response.json()]
 
     def get_location_by_id(self, id: int) -> Location:
         response = requests.get(f"{self.get_base_url()}/{id}")
         if response.status_code == 404:
             raise Exception(f"Location not found with id: {id}")
         response.raise_for_status()
-        return response.json()
+        return Location(**response.json())
 
     def get_locations_in_environment(self, environment_id: int) -> List[Location]:
         response = requests.get(f"{self.get_base_url()}/environment/{environment_id}")
         response.raise_for_status()
-        return response.json()
+        return [Location(**loc) for loc in response.json()]
 
     def get_locations_in_grid(self, grid_id: int) -> List[Location]:
         response = requests.get(f"{self.get_base_url()}/grid/{grid_id}")
         response.raise_for_status()
-        return response.json()
+        return [Location(**loc) for loc in response.json()]
 
     def get_location_of_entity(self, entity_id: int) -> Location:
         response = requests.get(f"{self.get_base_url()}/entity/{entity_id}")
         if response.status_code == 404:
             raise Exception(f"Location not found for entity: {entity_id}")
         response.raise_for_status()
-        return response.json()
+        return Location(**response.json())
 
     def add_entity_to_location(self, entity_id: int, location_id: int) -> None:
         response = requests.put(f"{self.get_base_url()}/{location_id}/entity/{entity_id}")

src/main/resources/application.properties

@@ -4,9 +4,9 @@
 spring.application.name=viron
 server.port=9999
 
-config.dbUrl=jdbc:postgresql://localhost:5432/postgres
-config.dbUsername=postgres
-config.dbPassword=postgres
+database.dbUrl=jdbc:postgresql://localhost:5432/postgres
+database.dbUsername=postgres
+database.dbPassword=postgres
 
-config.vironHost=http://localhost
-config.vironPort=9999
+service.vironHost=http://localhost
+service.vironPort=9999

src/test/java/preponderous/viron/controllers/DebugControllerTest.java

@@ -39,9 +39,5 @@ public void setUp() {
         debugController = new DebugController(entityService, environmentService, gridService, locationService);
     }
 
-    @Test
-    public void testHealthCheck() {
-        String response = debugController.healthCheck();
-        assertEquals("OK", response);
-    }
+    // TODO: implement tests for DebugController methods
 }