Merge pull request #4780 from linuxfoundation/unicron-4762-cypress-apis-test-coverage-2

Fixing the test coverage and fixing bug in API

Author: lukaszgryglicki

.gitignore

@@ -258,3 +258,4 @@ cover.out
 src.txt
 src.txt.*
 out.json
+body.json

cla-backend-go/v2/cla_manager/service.go

@@ -1167,8 +1167,14 @@ func (s *service) NotifyCLAManagers(ctx context.Context, notifyCLAManagers *mode
 	// Search for Easy CLA User
 	log.WithFields(f).Debugf("Getting user by ID: %s", notifyCLAManagers.UserID)
 	userModel, userErr := s.easyCLAUserService.GetUser(notifyCLAManagers.UserID)
+	// log.WithFields(f).Debugf("Got user by ID: %s -> (%+v, %+v)", notifyCLAManagers.UserID, userModel, userErr)
 	if userErr != nil {
-		msg := fmt.Sprintf("Problem getting user by ID: %s ", notifyCLAManagers.UserID)
+		msg := fmt.Sprintf("Problem getting user by ID: %s: %v", notifyCLAManagers.UserID, userErr)
+		log.WithFields(f).Warn(msg)
+		return ErrCLAUserNotFound
+	}
+	if userModel == nil {
+		msg := fmt.Sprintf("Problem getting user by ID: %s", notifyCLAManagers.UserID)
 		log.WithFields(f).Warn(msg)
 		return ErrCLAUserNotFound
 	}

cla-backend-go/v2/signatures/service.go

@@ -381,6 +381,10 @@ func (s *Service) InvalidateICLA(ctx context.Context, claGroupID string, userID
 		log.WithFields(f).Debug("unable to get user record")
 		return userErr
 	}
+	if user == nil {
+		log.WithFields(f).Debug("unable to get user record")
+		return fmt.Errorf("user not found for userID: %s", userID)
+	}
 
 	log.WithFields(f).Debug("invalidating signature record ...")
 	note := fmt.Sprintf("Signature invalidated (approved set to false) by %s for %s ", authUser.UserName, utils.GetBestUsername(user))

tests/functional/cypress.config.ts

@@ -12,11 +12,15 @@ export default defineConfig({
     setupNodeEvents(on, config) {
       on('task', {
         log(message: string) {
-          console.log(message);
+          if (process.env.DEBUG) {
+            console.log(message);
+          }
           return null;
         },
         table(rows: any[]) {
-          console.table(rows);
+          if (process.env.DEBUG) {
+            console.table(rows);
+          }
           return null;
         },
       });

tests/functional/cypress/appConfig/config.dev.ts

@@ -15,6 +15,8 @@ export const appConfig = {
   user_id: '8f3e52b8-0072-11ee-9def-0ef17207dfe8', //[email protected]
   userEmail: '[email protected]',
   user_id2: '4a4c1dba-407f-11ed-8c58-a6b0f8fb81a9', //[email protected]
+  user_id3: '9dcf5bbc-2492-11ed-97c7-3e2a23ea20b5', // lgryglicki
+  userEmail3: '[email protected]',
 
   /*events*/
   companyID: 'f7c7ac9c-4dbf-4104-ab3f-6b38a26d82dc', //infosys limited
@@ -31,6 +33,7 @@ export const appConfig = {
 
   /*cla-manager*/
   userIdclaManager: 'c5ac2857-c263-11ed-94d1-d2349de32229', //veerendrat
+  userIdclaManager2: '9dcf5bbc-2492-11ed-97c7-3e2a23ea20b5', // lgryglicki
   claGroupId_projectSFID: '01af041c-fa69-4052-a23c-fb8c1d3bef24', //sun project claGroupID
 
   /* project */
@@ -48,4 +51,11 @@ export const appConfig = {
   gitUsernameApprovalList: 'vrthakur',
   gitLabOrgApprovalList: 'https://gitlab.com/veerendrat1',
   domainApprovalList: 'proximabiz.com',
+  // lgryglicki
+  lfid2: 'lgryglicki',
+  emailApprovalList2: '[email protected]',
+  gitOrgApprovalList2: 'o2.pl',
+  gitUsernameApprovalList2: 'lukaszgryglicki',
+  gitLabOrgApprovalList2: 'https://gitlab.com/lukaszgryglicki',
+  domainApprovalList2: 'o2.pl',
 };

tests/functional/cypress/e2e/cla-group.cy.ts

@@ -1,4 +1,11 @@
-import { validateApiResponse, validate_200_Status, validate_404_Status, getTokenKey } from '../support/commands';
+import {
+  validateApiResponse,
+  validate_200_Status,
+  validate_404_Status,
+  getTokenKey,
+  getAPIBaseURL,
+  getXACLHeader,
+} from '../support/commands';
 
 describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on child project", function () {
   // Define a variable for the environment
@@ -14,7 +21,7 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
 
   //Reference api doc: https://api-gw.dev.platform.linuxfoundation.org/cla-service/v4/api-docs#tag/cla-group
 
-  const claEndpoint = `${Cypress.env('APP_URL')}cla-service/v4`;
+  const claEndpoint = getAPIBaseURL('v4');
   let claGroupId: string = '';
 
   //Variable for create cla group
@@ -49,9 +56,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Creates a new CLA Group at child level - Record should return 200 Response', function () {
     cy.request({
       method: 'POST',
-      url: `${claEndpoint}/cla-group`,
+      url: `${claEndpoint}cla-group`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -106,9 +113,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Get list of cla group associated with project - Record should return 200 Response', function () {
     cy.request({
       method: 'GET',
-      url: `${claEndpoint}/foundation/${projectSfid}/cla-groups`,
+      url: `${claEndpoint}foundation/${projectSfid}/cla-groups`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -130,8 +137,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Attempt to get list of cla group associated with project given by wrong SFID - Record should Return 404 Response', function () {
     cy.request({
       method: 'GET',
-      url: `${claEndpoint}/foundation/${projectSfid}-xyz/cla-groups`,
+      url: `${claEndpoint}foundation/${projectSfid}-xyz/cla-groups`,
       failOnStatusCode: false,
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -145,9 +153,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Updates a CLA Group details - Record should return 200 Response', function () {
     cy.request({
       method: 'PUT',
-      url: `${claEndpoint}/cla-group/${claGroupId}`,
+      url: `${claEndpoint}cla-group/${claGroupId}`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -171,9 +179,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Enroll projects in a CLA Group - Record should return 200 Response', function () {
     cy.request({
       method: 'PUT',
-      url: `${claEndpoint}/cla-group/${claGroupId}/enroll-projects`,
+      url: `${claEndpoint}cla-group/${claGroupId}/enroll-projects`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -186,9 +194,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
         // Run the second API request
         cy.request({
           method: 'GET',
-          url: `${claEndpoint}/foundation/${projectSfid}/cla-groups`,
+          url: `${claEndpoint}foundation/${projectSfid}/cla-groups`,
           failOnStatusCode: allowFail,
-
+          headers: getXACLHeader(),
           auth: {
             bearer: bearerToken,
           },
@@ -209,9 +217,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Unenroll projects in a CLA Group - Record should return 200 Response', function () {
     cy.request({
       method: 'PUT',
-      url: `${claEndpoint}/cla-group/${claGroupId}/unenroll-projects`,
+      url: `${claEndpoint}cla-group/${claGroupId}/unenroll-projects`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -225,9 +233,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Get list of Github organization associated with project - Record should return 200 Response', function () {
     cy.request({
       method: 'GET',
-      url: `${claEndpoint}/project/${projectSfidOrg}/github/organizations`,
+      url: `${claEndpoint}project/${projectSfidOrg}/github/organizations`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -248,9 +256,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
   it('Update GitHub Organization Configuration - Record should return 200 Response', function () {
     cy.request({
       method: 'PUT',
-      url: `${claEndpoint}/project/${projectSfidOrg}/github/organizations/${gitHubOrgName}/config`,
+      url: `${claEndpoint}project/${projectSfidOrg}/github/organizations/${gitHubOrgName}/config`,
       failOnStatusCode: allowFail,
-
+      headers: getXACLHeader(),
       auth: {
         bearer: bearerToken,
       },
@@ -268,9 +276,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
     if (claGroupId != null) {
       cy.request({
         method: 'DELETE',
-        url: `${claEndpoint}/cla-group/${claGroupId}`,
+        url: `${claEndpoint}cla-group/${claGroupId}`,
         failOnStatusCode: allowFail,
-
+        headers: getXACLHeader(),
         auth: {
           bearer: bearerToken,
         },
@@ -281,9 +289,9 @@ describe("To Validate 'GET, CREATE, UPDATE and DELETE' CLA groups API call on ch
           // Run the second API request
           cy.request({
             method: 'GET',
-            url: `${claEndpoint}/foundation/${projectSfid}/cla-groups`,
+            url: `${claEndpoint}foundation/${projectSfid}/cla-groups`,
             failOnStatusCode: allowFail,
-
+            headers: getXACLHeader(),
             auth: {
               bearer: bearerToken,
             },