TMS Migration (to develop)

.gitignore

@@ -19,3 +19,4 @@ hs_err_pid*
 build/
 .gradle/
 out/
+src/test/resources/db/migration/*.sql

build.gradle

@@ -93,6 +93,8 @@ dependencies {
 
     // JasperReport's export to XLS uses Apache POI and openpdf for PDF export
     implementation(libs.apache.poi)
+    implementation(libs.apache.poi.ooxml)
+    implementation(libs.apache.commons.commonscsv)
     implementation(libs.openpdf)
     implementation(libs.jakarta.inject.api)
     implementation(libs.jakarta.mail)
@@ -112,6 +114,10 @@ dependencies {
     compileOnly(libs.lombok)
     annotationProcessor(libs.lombok)
 
+    //mapstruct
+    implementation(libs.mapstruct)
+    annotationProcessor(libs.mapstruct.processor)
+
     //  Tests
     testImplementation(libs.bundles.test.libs)
     testCompileOnly(libs.lombok)

doc/importFromQASpace.md

@@ -0,0 +1,15 @@
+| Source QASpace Field | Target TMS Entity and Field | Mapping Schema |
+| :-- | :-- | :-- |
+| path | TmsTestFolder hierarchy | The path string is split by the separator / and a folder hierarchy is created in TmsTestFolder. The last folder in the hierarchy will contain the test case. |
+| priority | TmsTestCase.priority | New field that needs to be added to TmsTestCase. Possible values: "Minor", "Major", "Critical", "Blocker". |
+| summary | TmsTestCase.name | Direct mapping to the name field. |
+| test steps | TmsTestCaseVersion.manualScenario.steps[].instructions | Text from the "test steps" field needs to be split into separate steps and create a record in TmsStep for each step, filling the instructions field. |
+| expected result | TmsTestCaseVersion.manualScenario.steps[].expectedResult | Text from the "expected result" field needs to be split into separate expected results corresponding to the steps, and fill the expectedResult field for each step. |
+| status | New field in manual execution | Do not map for now (will be added later). |
+| test type | New field in manual execution | Do not map for now (will be added later). |
+| description | TmsTestCase.description | Direct mapping to the description field. |
+| labels | TmsTestCase.tags | For each value in the "labels" field, create a record inTmsAttribute with key == "label" and link through TmsTestCaseAttribute |
+| components | Do not map | According to requirements, no need to import. |
+| versions | Do not map | According to requirements, no need to import. |
+| bugs (not imported) | Do not map | According to requirements, no need to import. |
+| requirements | TmsTestCaseVersion.manualScenario.linkToRequirements | Direct mapping to the linkToRequirements field. |

gradle.properties

@@ -11,4 +11,4 @@ dockerJavaOptsDev=-DLOG_FILE=app.log \
                   -Djava.security.egd=file:/dev/./urandom \
                   -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
 dockerServerUrl=unix:///var/run/docker.sock
-org.gradle.jvmargs=-Xmx2048m
+org.gradle.jvmargs=-Xmx2048m

gradle/libs.versions.toml

@@ -1,7 +1,7 @@
 [versions]
 # Development versions
 commons-dev = "f7c7d2c"
-commons-dao-dev = "f7ac74d"
+commons-dao-dev = "accffcbc73"
 plugin-api-dev = "87b8788"
 
 # Platform versions
@@ -37,6 +37,8 @@ lombok = "1.18.36"
 jooq = "3.19.18"
 jclouds = "2.6.0"
 hibernate-validator = "8.0.2.Final"
+mapstruct = "1.5.5.Final"
+apache-commons-csv = "1.10.0"
 
 [libraries]
 # Development libs
@@ -80,6 +82,7 @@ rabbitmq-http-client = { group = "com.rabbitmq", name = "http-client", version.r
 httpclient5 = { group = "org.apache.httpcomponents.client5", name = "httpclient5", version.ref = "httpclient5" }
 jasperreports = { group = "net.sf.jasperreports", name = "jasperreports", version.ref = "jasperreports" }
 apache-poi = { group = "org.apache.poi", name = "poi", version.ref = "apache-poi" }
+apache-poi-ooxml = { group = "org.apache.poi", name = "poi-ooxml", version.ref = "apache-poi" }
 openpdf = { group = "com.github.librepdf", name = "openpdf", version.ref = "openpdf" }
 jakarta-inject-api = { group = "jakarta.inject", name = "jakarta.inject-api", version.ref = "jakarta-inject" }
 jakarta-mail = { group = "com.sun.mail", name = "jakarta.mail", version.ref = "jakarta-mail" }
@@ -92,10 +95,15 @@ apache-commons-compress = { group = "org.apache.commons", name = "commons-compre
 hibernate-validator = { group = "org.hibernate.validator", name = "hibernate-validator", version.ref = "hibernate-validator" }
 json-schema-validator = { group = "com.networknt", name = "json-schema-validator", version.ref = "json-schema-validator" }
 caffeine = { group = "com.github.ben-manes.caffeine", name = "caffeine" }
+apache-commons-commonscsv = { group = "org.apache.commons", name = "commons-csv", version.ref = "apache-commons-csv" }
 
 # Lombok
 lombok = { group = "org.projectlombok", name = "lombok", version.ref = "lombok" }
 
+# Mapstruct
+mapstruct = { group = "org.mapstruct", name = "mapstruct", version.ref = "mapstruct" }
+mapstruct-processor = { group = "org.mapstruct", name = "mapstruct-processor", version.ref = "mapstruct" }
+
 # Test libraries
 spring-test = { group = "org.springframework", name = "spring-test" }
 flyway-spring-test = { group = "org.flywaydb.flyway-test-extensions", name = "flyway-spring-test", version.ref = "flyway-spring-test" }

project-properties.gradle

@@ -16,7 +16,7 @@ project.ext {
     isDebugMode = System.getProperty("DEBUG", "false") == "true"
     releaseMode = project.hasProperty("releaseMode") ? project.releaseMode.toBoolean() : false
     scriptsUrl = commonScriptsUrl + (releaseMode ? '5.14.0' : 'develop')
-    migrationsUrl = migrationsScriptsUrl + (releaseMode ? '5.14.0' : 'develop')
+    migrationsUrl = migrationsScriptsUrl + (releaseMode ? '5.14.0' : 'feature/EPMRPP-migrate-tms-to-develop')
     manifestSchemaUrl = schemaUrl + ('manifest.schema.json')
     //TODO refactor with archive download
     testScriptsSrc = [
@@ -78,6 +78,7 @@ project.ext {
             (migrationsUrl + '/migrations/96_create_groups_tables.up.sql')             : 'V096__create_groups_tables.sql',
             (migrationsUrl + '/migrations/97_add_groups_uuid.up.sql')                  : 'V097__add_groups_uuid.up.sql',
             (migrationsUrl + '/migrations/98_add_plugin_type.up.sql')                  : 'V098__add_plugin_type.up.sql',
+            (migrationsUrl + '/migrations/103_tms_initial.up.sql')                     : 'V103__tms_initial.up.sql',
             (migrationsUrl + '/migrations/198_add_slugify_function.up.sql')            : 'V198__add_slugify_function.sql',
             (migrationsUrl + '/migrations/199_organization_tables.up.sql')             : 'V199__organization_tables.sql',
             (migrationsUrl + '/migrations/200_migrate_org_roles.up.sql')               : 'V200__migrate_org_roles.sql',

src/main/java/com/epam/ta/reportportal/core/configs/MvcConfig.java

@@ -19,6 +19,7 @@
 import com.epam.ta.reportportal.ws.resolver.ActiveUserWebArgumentResolver;
 import com.epam.ta.reportportal.ws.resolver.FilterCriteriaResolver;
 import com.epam.ta.reportportal.ws.resolver.JsonViewSupportFactoryBean;
+import com.epam.ta.reportportal.ws.resolver.OffsetArgumentResolver;
 import com.epam.ta.reportportal.ws.resolver.PagingHandlerMethodArgumentResolver;
 import com.epam.ta.reportportal.ws.resolver.PredefinedFilterCriteriaResolver;
 import com.epam.ta.reportportal.ws.resolver.SortArgumentResolver;
@@ -97,6 +98,7 @@ public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentRes
     argumentResolvers.add(new ActiveUserWebArgumentResolver());
     argumentResolvers.add(new FilterCriteriaResolver());
     argumentResolvers.add(new PredefinedFilterCriteriaResolver());
+    argumentResolvers.add(new OffsetArgumentResolver());
   }
 
   @Override

src/main/java/com/epam/ta/reportportal/core/configs/SchedulerConfiguration.java

@@ -16,6 +16,7 @@
 package com.epam.ta.reportportal.core.configs;
 
 import com.epam.reportportal.extension.classloader.ReportPortalResourceLoader;
+import com.epam.ta.reportportal.core.tms.scheduled.TmsAttachmentCleanupJob;
 import com.epam.ta.reportportal.job.CleanExpiredCreationBidsJob;
 import com.epam.ta.reportportal.job.FlushingDataJob;
 import com.epam.ta.reportportal.job.InterruptBrokenLaunchesJob;
@@ -70,6 +71,9 @@ public class SchedulerConfiguration {
   @Autowired
   private ReportPortalResourceLoader resourceLoader;
 
+  @Autowired
+  private TmsAttachmentCleanupJob tmsAttachmentCleanupJob;
+
   @Bean
   @Primary
   public SchedulerFactoryBean schedulerFactoryBean() {
@@ -162,6 +166,18 @@ public SimpleTriggerFactoryBean createTrigger(JobDetail jobDetail, long pollFreq
     return factoryBean;
   }
 
+  @Bean
+  public SimpleTriggerFactoryBean tmsAttachmentCleanupTrigger(
+      @Named("tmsAttachmentCleanupJobBean") JobDetail jobDetail,
+      @Value("${rp.tms.attachment.cleanup.cleanup.cron}") String cleanupCron) {
+    return createTrigger(jobDetail, Duration.parse(cleanupCron).toMillis());
+  }
+
+  @Bean("tmsAttachmentCleanupJobBean")
+  public JobDetailFactoryBean tmsAttachmentCleanupJob() {
+    return createJobDetail(TmsAttachmentCleanupJob.class);
+  }
+
   public SimpleTriggerFactoryBean createTriggerDelayed(JobDetail jobDetail, long pollFrequencyMs) {
     SimpleTriggerFactoryBean factoryBean = new SimpleTriggerFactoryBean();
     factoryBean.setJobDetail(jobDetail);

src/main/java/com/epam/ta/reportportal/core/settings/ServerSettingsRegistry.java

@@ -30,7 +30,6 @@
  * Add new handlers by implementing {@link ServerSettingHandler} and annotating with {@code @Service}
  *
  * @author <a href="mailto:[email protected]">Pavel Bortnik</a>
- * @Component}.
  */
 @Component
 public class ServerSettingsRegistry {

src/main/java/com/epam/ta/reportportal/core/tms/controller/ProductVersionController.java

@@ -0,0 +1,111 @@
+package com.epam.ta.reportportal.core.tms.controller;
+
+import com.epam.ta.reportportal.commons.EntityUtils;
+import com.epam.ta.reportportal.commons.ReportPortalUser;
+import com.epam.ta.reportportal.core.tms.dto.ProductVersionRQ;
+import com.epam.ta.reportportal.core.tms.dto.TmsProductVersionRS;
+import com.epam.ta.reportportal.core.tms.service.ProductVersionService;
+import com.epam.ta.reportportal.util.ProjectExtractor;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Controller for managing product versions within a project. Each endpoint
+ * in this controller is secured and requires the user to have administrator
+ * privileges. Operations supported include creating, retrieving, updating,
+ * and deleting product versions associated with a specific project.
+ */
+@RestController
+@RequestMapping("/v1/project/{projectKey}/tms/productversion")
+@Tag(name = "Product Version", description = "Product Version API collection")
+@RequiredArgsConstructor
+public class ProductVersionController {
+
+  private final ProductVersionService productVersionService;
+  private final ProjectExtractor projectExtractor;
+
+  /**
+   * Retrieves a specific product version by its ID within a project.
+   *
+   * @param projectKey        The key of the project to which the product version belongs.
+   * @param productVersionId The ID of the product version to retrieve.
+   * @return A data transfer object ({@link TmsProductVersionRS}) containing details of the product version.
+   */
+  @GetMapping("/{productVersionId}")
+  TmsProductVersionRS getById(@PathVariable("projectKey") String projectKey,
+      @PathVariable("productVersionId") final long productVersionId,
+      @AuthenticationPrincipal ReportPortalUser user) {
+    return productVersionService.getById(
+        projectExtractor
+            .extractMembershipDetails(user, EntityUtils.normalizeId(projectKey))
+            .getProjectId(),
+        productVersionId);
+  }
+
+  /**
+   * Creates a new product version in the specified project.
+   *
+   * @param projectKey The key of the project to which the new product version will be added.
+   * @param inputDto  A request payload ({@link ProductVersionRQ}) containing information
+   *                  about the product version to create.
+   * @return A data transfer object ({@link TmsProductVersionRS}) with details of the created product version.
+   */
+  @PostMapping
+  TmsProductVersionRS createVersion(@PathVariable("projectKey") String projectKey,
+      @RequestBody final ProductVersionRQ inputDto,
+      @AuthenticationPrincipal ReportPortalUser user) {
+    return productVersionService.create(
+        projectExtractor
+            .extractMembershipDetails(user, EntityUtils.normalizeId(projectKey))
+            .getProjectId(),
+        inputDto);
+  }
+
+  /**
+   * Updates the details of an existing product version in a project.
+   *
+   * @param projectKey        The key of the project to which the product version belongs.
+   * @param productVersionId The ID of the product version to update.
+   * @param inputDto         A request payload ({@link ProductVersionRQ}) containing updated information
+   *                         for the product version.
+   * @return A data transfer object ({@link TmsProductVersionRS}) with updated details of the product version.
+   */
+  @PutMapping("/{productVersionId}")
+  TmsProductVersionRS updateVersion(@PathVariable("projectKey") String projectKey,
+      @PathVariable("productVersionId") final long productVersionId,
+      @RequestBody final ProductVersionRQ inputDto,
+      @AuthenticationPrincipal ReportPortalUser user) {
+    return productVersionService.update(
+        projectExtractor
+            .extractMembershipDetails(user, EntityUtils.normalizeId(projectKey))
+            .getProjectId(),
+        productVersionId,
+        inputDto);
+  }
+
+  /**
+   * Deletes a specific product version from a project.
+   *
+   * @param projectKey        The key of the project to which the product version belongs.
+   * @param productVersionId The ID of the product version to delete.
+   */
+  @DeleteMapping("/{productVersionId}")
+  void deleteVersion(@PathVariable("projectKey") String projectKey,
+      @PathVariable("productVersionId") final long productVersionId,
+      @AuthenticationPrincipal ReportPortalUser user) {
+    productVersionService.delete(
+        projectExtractor
+            .extractMembershipDetails(user, EntityUtils.normalizeId(projectKey))
+            .getProjectId(),
+        productVersionId);
+  }
+}