get /tables endpoint

beekeeper-api/pom.xml

@@ -11,6 +11,10 @@
 
   <artifactId>beekeeper-api</artifactId>
 
+  <properties>
+    <specification-arg-resolver.version>2.6.1</specification-arg-resolver.version>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>org.springframework.boot</groupId>
@@ -20,6 +24,36 @@
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-actuator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.expediagroup</groupId>
+      <artifactId>beekeeper-core</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>net.kaczmarzyk</groupId>
+      <artifactId>specification-arg-resolver</artifactId>
+      <version>${specification-arg-resolver.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20080701</version>
+    </dependency>
+
+    <!-- test -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+    </dependency>
   </dependencies>
 
 </project>

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/BeekeeperApiApplication.java

@@ -0,0 +1,52 @@
+/**
+ * Copyright (C) 2019-2021 Expedia, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.expediagroup.beekeeper.api;
+
+import javax.annotation.PostConstruct;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.domain.EntityScan;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+
+@SpringBootApplication
+@EnableConfigurationProperties
+@EntityScan(basePackages = { "com.expediagroup.beekeeper.core.model" })
+@EnableJpaRepositories(basePackages = { "com.expediagroup.beekeeper.core.repository" })
+@ComponentScan(basePackages = {
+    "com.expediagroup.beekeeper.api.conf",
+    "com.expediagroup.beekeeper.api.controller",
+    "com.expediagroup.beekeeper.api.service" })
+public class BeekeeperApiApplication {
+
+  @Autowired
+  private ObjectMapper objectMapper;
+
+  public static void main(String[] args) {
+    SpringApplication.run(BeekeeperApiApplication.class, args);
+  }
+
+  @PostConstruct
+  public void setUp() {
+    objectMapper.registerModule(new JavaTimeModule());
+  }
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/conf/JPAConfiguration.java

@@ -0,0 +1,35 @@
+/**
+ * Copyright (C) 2019-2021 Expedia, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.expediagroup.beekeeper.api.conf;
+
+import java.util.List;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+import org.springframework.web.method.support.HandlerMethodArgumentResolver;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import net.kaczmarzyk.spring.data.jpa.web.SpecificationArgumentResolver;
+
+@Configuration
+@EnableJpaRepositories
+public class JPAConfiguration implements WebMvcConfigurer {
+
+  @Override
+  public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
+    argumentResolvers.add(new SpecificationArgumentResolver());
+  }
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/controller/BeekeeperController.java

@@ -0,0 +1,70 @@
+/**
+ * Copyright (C) 2019-2021 Expedia, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.expediagroup.beekeeper.api.controller;
+
+
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+
+import static com.expediagroup.beekeeper.api.response.HousekeepingMetadataResponse.convertToHouseKeepingMetadataResponsePage;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.domain.Specification;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import net.kaczmarzyk.spring.data.jpa.domain.EqualIgnoreCase;
+import net.kaczmarzyk.spring.data.jpa.domain.GreaterThan;
+import net.kaczmarzyk.spring.data.jpa.domain.LessThan;
+import net.kaczmarzyk.spring.data.jpa.web.annotation.And;
+import net.kaczmarzyk.spring.data.jpa.web.annotation.Spec;
+
+import com.expediagroup.beekeeper.api.response.HousekeepingMetadataResponse;
+import com.expediagroup.beekeeper.api.service.BeekeeperService;
+import com.expediagroup.beekeeper.api.service.HousekeepingMetadataService;
+import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
+
+@RequestMapping("/api/v1")
+@RestController
+public class BeekeeperController {
+  private final BeekeeperService beekeeperService;
+
+  @Autowired
+  public BeekeeperController(HousekeepingMetadataService housekeepingMetadataService,
+      BeekeeperService beekeeperService) {
+    this.beekeeperService = beekeeperService;
+  }
+
+  @GetMapping(path = "/tables", produces = APPLICATION_JSON_VALUE)
+  public ResponseEntity<Page<HousekeepingMetadataResponse>> getAll(
+      @And({
+          @Spec(path = "tableName", params = "table_name", spec = EqualIgnoreCase.class),
+          @Spec(path = "databaseName", params = "database_name", spec = EqualIgnoreCase.class),
+          @Spec(path = "housekeepingStatus", params = "housekeeping_status", spec = EqualIgnoreCase.class),
+          @Spec(path = "lifecycleType", params = "lifecycle_type", spec = EqualIgnoreCase.class),
+          @Spec(path = "cleanupTimestamp", params = "deleted_before", spec = LessThan.class),
+          @Spec(path = "cleanupTimestamp", params = "deleted_after", spec = GreaterThan.class),
+          @Spec(path = "creationTimestamp", params = "registered_before", spec = LessThan.class),
+          @Spec(path = "creationTimestamp", params = "registered_after", spec = GreaterThan.class)
+      })
+      Specification<HousekeepingMetadata> spec, Pageable pageable) {
+    return ResponseEntity.ok(beekeeperService.getAllTables(spec, pageable));
+  }
+
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/response/HousekeepingMetadataResponse.java

@@ -0,0 +1,103 @@
+package com.expediagroup.beekeeper.api.response;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import javax.persistence.Column;
+import javax.persistence.Table;
+
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+
+import lombok.Builder;
+import lombok.Value;
+
+import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
+
+@Value
+@Builder
+@Table(name = "housekeeping_metadata")
+public class HousekeepingMetadataResponse {
+
+  @Column(name = "database_name", nullable = false)
+  String databaseName;
+
+  @Column(name = "table_name", nullable = false)
+  String tableName;
+
+  @Column(name = "path", nullable = false)
+  String path;
+
+  @Column(name = "lifecycles", nullable = false)
+  List<Lifecycle> lifecycles;
+
+  public static HousekeepingMetadataResponse convertToHouseKeepingMetadataResponse(
+      HousekeepingMetadata housekeepingMetadata) {
+    List<Lifecycle> lifecyclesList = new ArrayList<>();
+    Lifecycle lifecycle = Lifecycle.builder()
+        .lifecycleEventType(housekeepingMetadata.getLifecycleType())
+        .configuration(Map.of(
+            "beekeeper.unreferenced.data.retention.period",housekeepingMetadata.getCleanupDelay().toString(),
+            "clean up timestamp", housekeepingMetadata.getCleanupTimestamp().toString()
+        ))
+        .build()
+        ;
+    lifecyclesList.add(lifecycle);
+
+    return HousekeepingMetadataResponse.builder()
+        .databaseName(housekeepingMetadata.getDatabaseName())
+        .tableName(housekeepingMetadata.getTableName())
+        .path(housekeepingMetadata.getPath())
+        .lifecycles(lifecyclesList)
+        .build();
+  }
+
+  public static Page<HousekeepingMetadataResponse> convertToHouseKeepingMetadataResponsePage(List<HousekeepingMetadata> housekeepingMetadataList){
+    List<HousekeepingMetadataResponse> housekeepingMetadataResponseList = new ArrayList<>();
+    for (HousekeepingMetadata housekeepingMetadata : housekeepingMetadataList) {
+      HousekeepingMetadataResponse housekeepingMetadataResponse = convertToHouseKeepingMetadataResponse(housekeepingMetadata);
+      int repeatedTablePosition = checkIfTableExists(housekeepingMetadataResponseList, housekeepingMetadata);
+
+      if(repeatedTablePosition!=-1){
+        housekeepingMetadataResponse = housekeepingMetadataResponseList.get(repeatedTablePosition);
+        housekeepingMetadataResponseList.remove(repeatedTablePosition);
+        Lifecycle lifecycle = Lifecycle.builder()
+            .lifecycleEventType(housekeepingMetadata.getLifecycleType())
+            .configuration(Map.of(
+                "beekeeper.unreferenced.data.retention.period",housekeepingMetadata.getCleanupDelay().toString(),
+                "clean up timestamp", housekeepingMetadata.getCleanupTimestamp().toString()
+                ))
+            .build();
+        housekeepingMetadataResponse.addLifecycle(lifecycle);
+      }
+
+      housekeepingMetadataResponseList.add(housekeepingMetadataResponse);
+    }
+    return new PageImpl<>(housekeepingMetadataResponseList);
+  }
+
+  public static int checkIfTableExists(
+      List<HousekeepingMetadataResponse> housekeepingMetadataResponseList, HousekeepingMetadata housekeepingMetadata){
+    int count = -1;
+    int positionOfRepeatedTable = -1;
+    String tableName1 = housekeepingMetadata.getTableName();
+    String databaseName1 = housekeepingMetadata.getDatabaseName();
+    if(!housekeepingMetadataResponseList.isEmpty()) {
+      for (HousekeepingMetadataResponse table : housekeepingMetadataResponseList) {
+        count++;
+        String tableName2 = table.getTableName();
+        String databaseName2 = table.getDatabaseName();
+        if (tableName1.equals(tableName2) && databaseName1.equals(databaseName2)) {
+          positionOfRepeatedTable = count;
+        }
+      }
+    }
+    return positionOfRepeatedTable;
+  }
+
+  public void addLifecycle(Lifecycle lifecycle){
+    lifecycles.add(lifecycle);
+  }
+
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/response/Lifecycle.java

@@ -0,0 +1,17 @@
+package com.expediagroup.beekeeper.api.response;
+
+import java.util.Map;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+public class Lifecycle {
+
+  String lifecycleEventType;
+  Map<String, String> configuration;
+
+
+
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/service/BeekeeperService.java

@@ -0,0 +1,26 @@
+package com.expediagroup.beekeeper.api.service;
+
+import static com.expediagroup.beekeeper.api.response.HousekeepingMetadataResponse.convertToHouseKeepingMetadataResponsePage;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.domain.Specification;
+import org.springframework.stereotype.Service;
+
+import com.expediagroup.beekeeper.api.response.HousekeepingMetadataResponse;
+import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
+
+@Service
+public class BeekeeperService {
+
+  private final HousekeepingMetadataService housekeepingMetadataService;
+
+  @Autowired
+  public BeekeeperService(
+      HousekeepingMetadataService housekeepingMetadataService) {this.housekeepingMetadataService = housekeepingMetadataService;}
+
+  public Page<HousekeepingMetadataResponse> getAllTables(Specification<HousekeepingMetadata> spec, Pageable pageable) {
+    return convertToHouseKeepingMetadataResponsePage(housekeepingMetadataService.getAll(spec, pageable).getContent());
+  }
+}

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/BeekeeperController.java → beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/service/HousekeepingEntityService.java

@@ -13,11 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.expediagroup.beekeeper.api;
+package com.expediagroup.beekeeper.api.service;
 
-import org.springframework.web.bind.annotation.RestController;
 
-@RestController
-public class BeekeeperController {
-
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.domain.Specification;
+
+import com.expediagroup.beekeeper.core.model.HousekeepingEntity;
+import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
+import com.expediagroup.beekeeper.core.model.HousekeepingPath;
+
+public interface HousekeepingEntityService<U extends HousekeepingEntity> {
+
+  Page<U> getAll(Specification<U> spec, Pageable pageable);
+
 }