Merge branch 'develop' into RefactoringStaticClass

Author: rishikunnath2747

.github/workflows/deploy_and_Integration_test.yml

@@ -176,13 +176,17 @@ jobs:
           clientSecret="${{ env.CLIENT_SECRET }}"
           username="${{ secrets.CF_USER }}"
           password="${{ secrets.CF_PASSWORD }}"
+          noSDMRoleUsername="${{ secrets.NOSDMROLEUSERNAME }}"
+          noSDMRoleUserPassword="${{ secrets.NOSDMROLEUSERPASSWORD }}"
           # Ensure all required variables are set
           if [ -z "$appUrl" ]; then echo "Error: appUrl is not set"; exit 1; fi
           if [ -z "$authUrl" ]; then echo "Error: authUrl is not set"; exit 1; fi
           if [ -z "$clientID" ]; then echo "Error: clientID is not set"; exit 1; fi
           if [ -z "$clientSecret" ]; then echo "Error: clientSecret is not set"; exit 1; fi
           if [ -z "$username" ]; then echo "Error: username is not set"; exit 1; fi
           if [ -z "$password" ]; then echo "Error: password is not set"; exit 1; fi
+          if [ -z "$noSDMRoleUsername" ]; then echo "Error: noSDMRoleUsername is not set"; exit 1; fi
+          if [ -z "$noSDMRoleUserPassword" ]; then echo "Error: noSDMRoleUserPassword is not set"; exit 1; fi
           # Function to partially mask sensitive information for logging
           mask() {
             local value="$1"
@@ -200,10 +204,12 @@ jobs:
           clientSecret=$clientSecret
           username=$username
           password=$password
+          noSDMRoleUsername=$noSDMRoleUsername
+          noSDMRoleUserPassword=$noSDMRoleUserPassword
           EOL
           # Run Maven integration tests
-          mvn clean verify -P integration-tests -DtokenFlow=technicalUser -DskipUnitTests || { echo "Maven tests failed for Technical User Flow"; exit 1; }
-          mvn clean verify -P integration-tests -DtokenFlow=namedUser -DskipUnitTests || { echo "Maven tests failed for Named User Flow"; exit 1; }
+          mvn clean verify -P integration-tests -DtokenFlow=namedUser -DtenancyModel=single -DskipUnitTests || { echo "Maven tests failed for Technical User Flow"; exit 1; }
+          mvn clean verify -P integration-tests -DtokenFlow=technicalUser -DtenancyModel=single -DskipUnitTests || { echo "Maven tests failed for Named User Flow"; exit 1; }
     
 
 

.github/workflows/integration_test.yml

@@ -91,13 +91,16 @@ jobs:
           clientSecret="${{ env.CLIENT_SECRET }}"
           username="${{ secrets.CF_USER }}"
           password="${{ secrets.CF_PASSWORD }}"
-
+          noSDMRoleUsername="${{ secrets.NOSDMROLEUSERNAME }}"
+          noSDMRoleUserPassword="${{ secrets.NOSDMROLEUSERPASSWORD }}"
           if [ -z "$appUrl" ]; then echo "Error: appUrl is not set"; exit 1; fi
           if [ -z "$authUrl" ]; then echo "Error: authUrl is not set"; exit 1; fi
           if [ -z "$clientID" ]; then echo "Error: clientID is not set"; exit 1; fi
           if [ -z "$clientSecret" ]; then echo "Error: clientSecret is not set"; exit 1; fi
           if [ -z "$username" ]; then echo "Error: username is not set"; exit 1; fi
           if [ -z "$password" ]; then echo "Error: password is not set"; exit 1; fi
+          if [ -z "$noSDMRoleUsername" ]; then echo "Error: noSDMRoleUsername is not set"; exit 1; fi
+          if [ -z "$noSDMRoleUserPassword" ]; then echo "Error: noSDMRoleUserPassword is not set"; exit 1; fi
 
           mask() {
             local value="$1"
@@ -115,8 +118,10 @@ jobs:
           clientSecret=$clientSecret
           username=$username
           password=$password
+          noSDMRoleUsername=$noSDMRoleUsername
+          noSDMRoleUserPassword=$noSDMRoleUserPassword
           EOL
 
           # Run Maven integration tests
-          mvn clean verify -P integration-tests -DtokenFlow=technicalUser -DskipUnitTests || { echo "Maven tests failed for Technical User Flow"; exit 1; }
-          mvn clean verify -P integration-tests -DtokenFlow=namedUser -DskipUnitTests || { echo "Maven tests failed for Named User Flow"; exit 1; }
+          mvn clean verify -P integration-tests -DtokenFlow=namedUser -DtenancyModel=single -DskipUnitTests || { echo "Maven tests failed for Technical User Flow"; exit 1; }
+          mvn clean verify -P integration-tests -DtokenFlow=technicalUser -DtenancyModel=single -DskipUnitTests || { echo "Maven tests failed for Named User Flow"; exit 1; }

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 1.4.0
+
+### Added
+- Support technical user flow.
+- Support codelist for custom properties.
+
+### Fixed
+- An issue where attachments uploaded with one repository was visible when application is redeployed with another repository.
+
 ## Version 1.3.1
 
 ### Fixed

README.md

@@ -15,6 +15,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Display attachments specific to repository: Lists attachments contained in the repository that is configured with the CAP application.
 - Maximum allowed uploads: Provides the capability to define the maximum number of uploads allowed for the user.
 - Multiple attachment facets: Provides the capability to define multiple attachment facets/sections in the CAP Entity.
+- Technical user support: Provides the capability to consume the plugin using technical user.
 
 ## Table of Contents
 
@@ -26,6 +27,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Custom Properties](#support-for-custom-properties)
 - [Support for Maximum allowed uploads](#support-for-maximum-allowed-uploads)
 - [Support for Multiple attachment facets](#support-for-multiple-attachment-facets)
+- [Support for Technical user](#support-for-technical-user)
 - [Known Restrictions](#known-restrictions)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
@@ -465,6 +467,24 @@ Add the following facet in _fiori-service.cds_ in the _app_ folder. Refer the fo
    >
    > Once a facet or section name is defined in the CDS file, it is strongly recommended not to modify it. For instance, in the example provided, section names such as attachments, references, and footnotes should remain unchanged after initial configuration. Renaming these sections will result in the creation of new tables, causing any data associated with the original sections to become inaccessible in the UI.
 
+## Support for technical user
+The CAP OData operations can be performed on attachments using a technical user. This flow can be used for machine-to-machine (M2M) interactions, where user involvement is not necessary.
+
+A leading CAP application's service should add the requires with annotation "system-user". For more detailed information on "system-user" within the SAP CAP framework, refer to the [Capire documentation](https://cap.cloud.sap/docs/guides/security/authorization#pseudo-roles). Here is an [example](https://github.com/cap-java/sdm/blob/develop_deploy/cap-notebook/demoapp/srv/admin-service.cds) from a sample Bookshop app demonstrating the implementation.
+```cds
+service AdminService @(requires: ['admin', 'system-user'])
+```
+
+The plugin supports technical users using oAuth 2.0 client credentials flow. Refer the following [example](https://github.com/cap-java/sdm/blob/a1bd1a0d829e6f25e4db349143b621757e0274d1/sdm/src/test/java/integration/com/sap/cds/sdm/IntegrationTest_SingleFacet.java#L80) of an OData call.
+```java
+request =
+   new Request.Builder()
+      .url(authUrl + "/oauth/token?grant_type=client_credentials")
+      .method("POST", body)
+      .addHeader("Authorization", basicAuth)
+      .build();
+```
+
 ## Known Restrictions
 
 - UI5 Version 1.135.0: This version causes error in upload of attachments.

pom.xml

@@ -23,7 +23,7 @@
     </developers>
 
     <properties>
-        <revision>1.3.2-SNAPSHOT</revision>
+        <revision>1.4.1-SNAPSHOT</revision>
         <java.version>17</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>

sdm/pom.xml

@@ -34,7 +34,7 @@
         <test-generation-folder>src/test/gen</test-generation-folder>
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
-        <attachments_version>1.0.7</attachments_version>
+        <attachments_version>1.0.9</attachments_version>
         <lombok.version>1.18.36</lombok.version>
         <jacoco.version>0.8.7</jacoco.version>
         <ehcache-version>3.10.8</ehcache-version>
@@ -114,6 +114,12 @@
     <groupId>org.apache.httpcomponents</groupId>
     <artifactId>httpasyncclient</artifactId>
     <version>${httpasyncclient-version}</version>
+    <exclusions>
+        <exclusion>
+            <groupId>commons-logging</groupId>
+            <artifactId>commons-logging</artifactId>
+        </exclusion>
+    </exclusions>
 </dependency>
 <!-- Log4j dependencies -->
 <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api -->

sdm/src/test/java/integration/com/sap/cds/sdm/Api.java

@@ -6,20 +6,22 @@
 import okhttp3.*;
 import okio.ByteString;
 
-public class Api {
+public class Api implements ApiInterface {
   private final Map<String, String> config;
   private final OkHttpClient httpClient;
   private static final ObjectMapper objectMapper = new ObjectMapper();
   private final String token;
+  private final String serviceName;
 
   public Api(Map<String, String> config) {
     this.config = new HashMap<>(config);
     this.httpClient = new OkHttpClient();
     this.token = this.config.get("Authorization");
+    this.serviceName = this.config.get("serviceName");
   }
 
   public String createEntityDraft(
-      String appUrl, String serviceName, String entityName, String entityName2, String srvpath) {
+      String appUrl, String entityName, String entityName2, String srvpath) {
     MediaType mediaType = MediaType.parse("application/json");
 
     // Creating the Entity (draft)
@@ -55,8 +57,7 @@ public String createEntityDraft(
     return ("Could not create entity");
   }
 
-  public String editEntityDraft(
-      String appUrl, String serviceName, String entityName, String srvpath, String entityID) {
+  public String editEntityDraft(String appUrl, String entityName, String srvpath, String entityID) {
     MediaType mediaType = MediaType.parse("application/json");
     Request request =
         new Request.Builder()
@@ -88,8 +89,7 @@ public String editEntityDraft(
     return "Could not edit entity";
   }
 
-  public String saveEntityDraft(
-      String appUrl, String serviceName, String entityName, String srvpath, String entityID) {
+  public String saveEntityDraft(String appUrl, String entityName, String srvpath, String entityID) {
     Request request =
         new Request.Builder()
             .url(
@@ -139,6 +139,10 @@ public String saveEntityDraft(
             System.out.println("Save entity failed. Error : " + draftResponseBodyString);
             return (draftResponseBodyString);
           }
+          String sapMessages = draftResponse.header("sap-messages");
+          if (sapMessages != null && !sapMessages.isEmpty()) {
+            return sapMessages;
+          }
           return "Saved";
         } catch (IOException e) {
           System.out.println("Could not save entity : " + e);
@@ -151,8 +155,7 @@ public String saveEntityDraft(
     return "Could not save entity";
   }
 
-  public String deleteEntity(
-      String appUrl, String serviceName, String entityName, String entityID) {
+  public String deleteEntity(String appUrl, String entityName, String entityID) {
     Request request =
         new Request.Builder()
             .url(
@@ -181,7 +184,7 @@ public String deleteEntity(
     return ("Could not delete entity");
   }
 
-  public String checkEntity(String appUrl, String serviceName, String entityName, String entityID) {
+  public String checkEntity(String appUrl, String entityName, String entityID) {
     Request request =
         new Request.Builder()
             .url(
@@ -212,7 +215,6 @@ public String checkEntity(String appUrl, String serviceName, String entityName,
 
   public List<String> createAttachment(
       String appUrl,
-      String serviceName,
       String entityName,
       String facetName,
       String entityID,
@@ -354,12 +356,7 @@ public List<String> createAttachment(
   }
 
   public String readAttachment(
-      String appUrl,
-      String serviceName,
-      String entityName,
-      String facetName,
-      String entityID,
-      String ID)
+      String appUrl, String entityName, String facetName, String entityID, String ID)
       throws IOException {
     Request request =
         new Request.Builder()
@@ -387,11 +384,11 @@ public String readAttachment(
       Response response = httpClient.newCall(request).execute();
       if (!response.isSuccessful()) {
         System.out.println(
-            "Read Attachnent failed in the"
+            "Read Attachment failed in the"
                 + facetName
                 + " section. Error :"
                 + response.body().string());
-        throw new IOException("Read Attachnent failed in the" + facetName + " section");
+        throw new IOException("Read Attachment failed in the" + facetName + " section");
       }
       return "OK";
     } catch (IOException e) {
@@ -401,12 +398,7 @@ public String readAttachment(
   }
 
   public String readAttachmentDraft(
-      String appUrl,
-      String serviceName,
-      String entityName,
-      String facetName,
-      String entityID,
-      String ID)
+      String appUrl, String entityName, String facetName, String entityID, String ID)
       throws IOException {
     Request request =
         new Request.Builder()
@@ -444,12 +436,7 @@ public String readAttachmentDraft(
   }
 
   public String deleteAttachment(
-      String appUrl,
-      String serviceName,
-      String entityName,
-      String facetName,
-      String entityID,
-      String ID) {
+      String appUrl, String entityName, String facetName, String entityID, String ID) {
     Request request =
         new Request.Builder()
             .url(
@@ -487,13 +474,7 @@ public String deleteAttachment(
   }
 
   public String renameAttachment(
-      String appUrl,
-      String serviceName,
-      String entityName,
-      String facetName,
-      String entityID,
-      String ID,
-      String name) {
+      String appUrl, String entityName, String facetName, String entityID, String ID, String name) {
     MediaType mediaType = MediaType.parse("application/json");
     RequestBody body =
         RequestBody.create(
@@ -537,7 +518,6 @@ public String renameAttachment(
 
   public String updateSecondaryProperty(
       String appUrl,
-      String serviceName,
       String entityName,
       String facetName,
       String entityID,
@@ -580,7 +560,6 @@ public String updateSecondaryProperty(
 
   public String updateInvalidSecondaryProperty(
       String appUrl,
-      String serviceName,
       String entityName,
       String facetName,
       String entityID,
@@ -624,12 +603,7 @@ public String updateInvalidSecondaryProperty(
   }
 
   public Map<String, Object> fetchMetadata(
-      String appUrl,
-      String serviceName,
-      String entityName,
-      String facetName,
-      String entityID,
-      String ID)
+      String appUrl, String entityName, String facetName, String entityID, String ID)
       throws IOException {
     // Construct the URL for fetching attachment metadata
     String url =