[WIT-2829] Implement the sync java tech adapter framework

# New features and improvements

* Implements support for synchronous validation, provisioning, unprovisioning, update ACL and reverse provisioning on the framework
* Provides autoconfiguration for ProvisionConfiguration and ValidationConfiguration classes with a failure behaviour, overridable by the user.
* Provides `ComponentClassProviderImpl` and `SpecificClassProviderImpl` as base implementations of their interfaces to easily bootstrap simple use-cases Tech Adapters.
* Provides a guide on how to bootstrap a brand new Tech Adapter, and how to migrate existing Tech Adapters that are based on the old Java Scaffold project.

# Related issue

Closes WIT-2829

# Definition of Done

So you are going to put your MR in review, but are you sure you have done all things listed here?

## All Developments

- [x] **Feature was implemented as per the requirements**
- [x] **If some code parts are complex they must be commented with code documentation**
- [x] **Unit, integration and E2E tests have been performed and code coverage is not reduced**, so that new code is covered
- [x] **CI/CD is successful**
- [x] **Exceptions and errors are handled, returning meaningful errors to the user**, without letting the underlying framework to respond with a generic Internal Server Error. Technical details are stored in the errors/problems and not in the user message
- [x] **Documentation (user documentation, HLD and others) has been updated**
  - Documentation has been updated with explanation of the new feature if it's user-facing (e.g. component now has additional setting) or it impacts them in some other way (e.g. optional field that becomes mandatory)
  - If it is a breaking change, we have documented it as such in the MR description in a "Breaking Changes" section
- [x] **Helm chart and other DevOps artifacts** have been updated and are valid deployment tools for the new version
- [x] **Problematic information (sensitive information, credentials, customer information or other intellectual property) is not included in the changes** as they could end up being public (most SPs are already published and automatically mirrored on every merge)
- [x] **Feature doesn't negatively affect any existing environments**, especially the clients Playgrounds. This means that merging it to master and deploying it to these environments will not break them and **no manual operations that are not reported in the documentation will be needed**
- [x] **If dependencies were changed, be sure that they will not impact the project**, that their license is compatible, and that they introduce no vulnerabilities
- [x] **Security, Authentication and Authorization have been considered**. No SQL injection, tokens handling, RBAC integration. Common security vulnerabilities identified and resolved

## API related Development

- [x] **API Parameters and return body are compliant** with the API specification
- [x] **Errors are correctly handled**, respecting the type of errors return bodies and responses for each endpoint
- [x] **API is logging in compliance with audit standards**, presence of sensitive information for GDPR has been assessed and removed or managed in case is needed

## DB related Development

- [ ] **The database schema is designed to accurately** represent the data model and meet the requirements
- [ ] **Tables, relationships, and constraints (e.g. primary keys, foreign keys, unique constraints) are defined appropriately**, following best practices and a common naming convention
- [ ] **Sensitive data is stored securely**, encrypted if required, and access is restricted to authorized users
- [ ] **Migration scripts to upgrade and downgrade the database have been implemented and tested**

Author: Sergio Andres Mejia Tovar

.gitignore

@@ -2,6 +2,7 @@ target/
 !.mvn/wrapper/maven-wrapper.jar
 !**/src/main/**/target/
 !**/src/test/**/target/
+.flattened-pom.xml
 
 ### IntelliJ IDEA ###
 .idea/modules.xml

.gitlab-ci.yml

@@ -4,13 +4,12 @@ include:
     file: 'common/witboost.helm.gitlab-ci.yml'
   - template: Security/SAST.gitlab-ci.yml
   - template: Security/Secret-Detection.gitlab-ci.yml
-  - template: Jobs/Container-Scanning.gitlab-ci.yml
 
 image: maven:3.9.4-eclipse-temurin-17
 
 variables:
-  MAVEN_CLI_OPTS: "-s ci_settings.xml --batch-mode"
-  MAVEN_OPTS: "-Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository"
+  MAVEN_CLI_OPTS: "--batch-mode"
+  MAVEN_OPTS: "-Dmaven.repo.local=$CI_PROJECT_DIR/.m2/repository -Drevision=$VERSION"
 
 cache:
   paths:
@@ -33,7 +32,6 @@ setup:
     - !reference [.witboost.helm.clone-scripts, script]
     - !reference [.witboost.helm.get-version, script]
     - echo "VERSION=${VERSION}" >> vars.env
-    - echo "FRAMEWORK_VERSION=${VERSION}" >> vars.env
   artifacts:
     reports:
       dotenv: vars.env
@@ -151,7 +149,7 @@ package:
     paths:
       - common/target/*.jar
 
-publish:
-  stage: publish
-  script:
-    - mvn -DskipTests=true deploy -s ci_settings.xml
+#publish:
+#  stage: publish
+#  script:
+#    - mvn -DskipTests=true deploy -s ci_settings.xml

README.md

@@ -14,6 +14,7 @@ This repository is part of our [Starter Kit](https://github.com/agile-lab-dev/wi
 - [Using this library](#using-this-library)
 - [Building](#building)
 - [API specification](docs/API.md)
+- [Compatibility matrix](docs/compatibility_matrix.md)
 - [License](#license)
 
 
@@ -90,48 +91,41 @@ pre-commit install
 
 ## Using this library
 
-Add the following dependency on your `pom.xml`:
-
-```xml
-<dependency>
-    <groupId>com.witboost.provisioning</groupId>
-    <artifactId>java-tech-adapter-framework-core</artifactId>
-    <version>${env.FRAMEWORK_VERSION}</version>
-</dependency>
-```
-
-Where `${env.FRAMEWORK_VERSION}` is the library version.
-
-To be able to use Spring Boot, you need to set Spring Boot 2.3.2 as a parent on your `pom.xml` and setup the actuator dependencies:
+Add the following on your `pom.xml`:
 
 ```xml
 <project ...>
+    ...
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>3.2.3</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
-    
+    ...
     <dependencies>
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-actuator</artifactId>
+            <groupId>com.witboost.provisioning</groupId>
+            <artifactId>java-tech-adapter-framework-core</artifactId>
+            <version>X.X.X</version>
         </dependency>
     </dependencies>
+    ...
 </project>
 ```
 
+Where `X.X.X` is the library version you desire to use.
+
 ### Implementing server logic
 
 The Java Tech Adapter Framework provides four interfaces to be implemented in order to plug your business logic into the provisioning workflow. These are:
 
-`ProvisionService`: Provides the business logic for component provision, unprovision, update access control, and reverse provisioning.
-`ComponentValidationService`: Provides the business logic for component validation, executed for validation and (un)provisioning operations.
-`ComponentClassProvider`: Interface that maps a component's `useCaseTemplateId` with a Class that represents the Component model, allowing to use extensions of the provided Components.
-`SpecificClassProvider`: Interface that maps a component's `useCaseTemplateId` with a Class that represents the Specific model.
+- `ProvisionService`: Provides the business logic for component provision, unprovision, update access control, and reverse provisioning.
+- `ComponentValidationService`: Provides the business logic for component validation, executed for validation and (un)provisioning operations.
+- `ComponentClassProvider`: Interface that maps a component's `useCaseTemplateId` with a Class that represents the Component model, allowing to use extensions of the provided Components.
+- `SpecificClassProvider`: Interface that maps a component's `useCaseTemplateId` with a Class that represents the Specific model.
 
-As of the current version, all four interfaces are mandatory, providing an failure default implementation for each method. To understand the details to implement these interfaces, check the guide. 
+As of the current version, all four interfaces are mandatory, providing a failure default implementation for each method. To understand the details to implement these interfaces, check the [implementation and migration guide](docs/usage.md). 
 
 ## Building
 
@@ -140,10 +134,16 @@ As of the current version, all four interfaces are mandatory, providing an failu
 - Java 17
 - Apache Maven 3.9+
 
-**Version:** the version is set dynamically via an environment variable, `FRAMEWORK_VERSION`. Make sure you have it exported, even for local development. Example:
+**Version:** the version is set dynamically via Maven configuration variables following the [CI Friendly Versions](https://maven.apache.org/maven-ci-friendly.html) setup, so be sure to configure your environment to include the Maven variable `revision` set to the version. For example, you can use the `MAVEN_OPTS` environment variable to set up this as:
 
 ```bash
-export FRAMEWORK_VERSION=0.0.0-SNAPHSOT
+export MAVEN_OPTS="-Drevision=0.0.0-SNAPHSOT"
+```
+
+*Note:* When running in the CI/CD pipeline the version for the project is automatically computed using information gathered from Git, using branch name and tags. Unless you are on a release branch `1.2.x` or a tag `v1.2.3` it will end up being `0.0.0`. You can follow this branch/tag convention or update the version computation to match your preferred strategy. When running locally if you do not care about the version (ie, nothing gets published or similar) you can manually set the Maven configuration variable `revision` to avoid warnings and oddly-named artifacts; as an example you can set it to the build using a timestamp like this:
+
+```bash
+export MAVEN_OPTS="-Drevision=$(date +%Y%m%d-%H%M%S)"
 ```
 
 **Build:**
@@ -172,24 +172,12 @@ mvn spotbugs:check
 mvn test
 ```
 
-**Artifacts & Docker image:** the project leverages Maven for packaging. Build artifacts (normal and fat jar) with:
-
-```bash
-mvn package spring-boot:repackage
-```
-
-The Docker image can be built with:
+**Artifacts:** the project leverages Maven for packaging. Build artifacts with:
 
 ```bash
-docker build .
+mvn package
 ```
 
-More details can be found [here](docs/docker.md).
-
-*Note:* when running in the CI/CD pipeline the version for the project is automatically computed using information gathered from Git, using branch name and tags. Unless you are on a release branch `1.2.x` or a tag `v1.2.3` it will end up being `0.0.0`. You can follow this branch/tag convention or update the version computation to match your preferred strategy. When running locally if you do not care about the version (ie, nothing gets published or similar) you can manually set the environment variable `FRAMEWORK_VERSION` to avoid warnings and oddly-named artifacts; as an example you can set it to the build time like this:
-```bash
-export FRAMEWORK_VERSION=$(date +%Y%m%d-%H%M%S);
-```
 
 **CI/CD:** the pipeline is based on GitLab CI as that's what we use internally. It's configured by the `.gitlab-ci.yaml` file in the root of the repository. You can use that as a starting point for your customizations.
 

ci_settings.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.witboost.provisioning</groupId>
         <artifactId>java-tech-adapter-framework</artifactId>
-        <version>${env.FRAMEWORK_VERSION}</version>
+        <version>${revision}</version>
     </parent>
 
     <properties>
@@ -15,18 +15,11 @@
     </properties>
 
     <artifactId>java-tech-adapter-framework-core</artifactId>
+    <name>java-tech-adapter-framework-core</name>
     <packaging>jar</packaging>
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-                <configuration>
-                    <mainClass>com.witboost.provisioning.framework.Main</mainClass>
-                    <layout>JAR</layout>
-                </configuration>
-            </plugin>
             <plugin>
                 <groupId>com.diffplug.spotless</groupId>
                 <artifactId>spotless-maven-plugin</artifactId>
@@ -57,7 +50,7 @@
             <plugin>
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>
-                <version>6.5.0</version>
+                <version>7.5.0</version>
                 <executions>
                     <execution>
                         <goals>
@@ -74,6 +67,7 @@
                             <supportingFilesToGenerate>
                                 ApiUtil.java
                             </supportingFilesToGenerate>
+
                             <configOptions>
                                 <sourceFolder>/src/main/java</sourceFolder>
                                 <implFolder>/src/main/java</implFolder>
@@ -93,49 +87,40 @@
         <dependency>
             <groupId>com.witboost.provisioning</groupId>
             <artifactId>java-tech-adapter-framework-model</artifactId>
-            <version>${env.FRAMEWORK_VERSION}</version>
+            <version>${project.parent.version}</version>
         </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.swagger.parser.v3</groupId>
-            <artifactId>swagger-parser</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.openapitools</groupId>
-            <artifactId>jackson-databind-nullable</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
         </dependency>
-
-        <dependency>
-            <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-tracing-bridge-otel</artifactId>
-        </dependency>
         <dependency>
-            <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-registry-prometheus</artifactId>
-            <scope>runtime</scope>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
-
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
 
         <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-web</artifactId>
+            <groupId>io.swagger.parser.v3</groupId>
+            <artifactId>swagger-parser</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
         </dependency>
 
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
+            <version>1.18.34</version>
             <optional>true</optional>
         </dependency>
 

core/pom.xml

@@ -0,0 +1,35 @@
+package com.witboost.provisioning.autoconfigure;
+
+import com.witboost.provisioning.framework.service.ProvisionConfiguration;
+import com.witboost.provisioning.framework.service.ProvisionService;
+import com.witboost.provisioning.framework.service.SyncTechAdapterService;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Provides autoconfiguration for the {@link ProvisionConfiguration} class which encapsulates the set of {@link ProvisionService}
+ * interfaces for the different types of supported components. Configures the behaviour as the interface default behaviour,
+ * which returns an error explaining that provisioning operations are not supported for any component.
+ *
+ * @see ProvisionConfiguration
+ * @see ProvisionService
+ */
+@Configuration
+@ConditionalOnClass(SyncTechAdapterService.class)
+public class ProvisionAutoConfiguration {
+
+    @Bean
+    @ConditionalOnMissingBean
+    public ProvisionConfiguration provisionConfiguration() {
+        return new ProvisionConfiguration(
+                new ProvisionService() {}, new ProvisionService() {}, new ProvisionService() {});
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    ProvisionService provisionService() {
+        return new ProvisionService() {};
+    }
+}

core/src/main/java/com/witboost/provisioning/autoconfigure/ProvisionAutoConfiguration.java

@@ -0,0 +1,49 @@
+package com.witboost.provisioning.autoconfigure;
+
+import com.witboost.provisioning.framework.service.ComponentClassProvider;
+import com.witboost.provisioning.framework.service.SpecificClassProvider;
+import com.witboost.provisioning.framework.service.impl.ComponentClassProviderImpl;
+import com.witboost.provisioning.framework.service.impl.SpecificClassProviderImpl;
+import com.witboost.provisioning.framework.service.validation.*;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Provides autoconfiguration for the validation and parsing interfaces, including the
+ * {@link ValidationConfiguration} class which encapsulates the set of {@link ComponentValidationService} interfaces for
+ * the different types of supported components, and the {@link ComponentClassProvider} and {@link SpecificClassProvider} for class mapping.
+ * Configures the behaviour as the interface default behaviour, which returns an error explaining that validation is not supported for any component.
+ *
+ * @see ValidationConfiguration
+ * @see ComponentValidationService
+ * @see ComponentClassProvider
+ * @see SpecificClassProvider
+ *
+ */
+@Configuration
+@ConditionalOnClass(ValidationServiceImpl.class)
+public class ValidationAutoConfiguration {
+
+    @Bean
+    @ConditionalOnMissingBean
+    public ValidationConfiguration validationConfiguration() {
+        return new ValidationConfiguration(
+                new ComponentValidationService() {},
+                new ComponentValidationService() {},
+                new ComponentValidationService() {});
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    public SpecificClassProvider specificMapper() {
+        return SpecificClassProviderImpl.builder().build();
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    public ComponentClassProvider componentClassProvider() {
+        return ComponentClassProviderImpl.builder().build();
+    }
+}

core/src/main/java/com/witboost/provisioning/autoconfigure/ValidationAutoConfiguration.java

@@ -0,0 +1,10 @@
+package com.witboost.provisioning.framework;
+
+/**
+ * Empty class to be used as a hook to enable package scanning by Spring Boot. It is intended to be part of the {@code @SpringBootApplication scanBasePackageClasses} and
+ * {@code @ConfigurationPropertiesScan basePackageClasses} on your Main application
+ *
+ * @see org.springframework.boot.autoconfigure.SpringBootApplication
+ * @see org.springframework.boot.context.properties.ConfigurationPropertiesScan
+ */
+public class JavaTechAdapterFramework {}