Final fix that allows 'compat' behaviour of V4 API that fallbacks to 'true' on 2 missing fields + test coverage

Signed-off-by: Łukasz Gryglicki <[email protected]>

Author: lukaszgryglicki

cla-backend-go/project/mocks/mock_repo.go

@@ -50,6 +50,7 @@ const (
 type ProjectRepository interface { //nolint
 	CreateCLAGroup(ctx context.Context, claGroupModel *models.ClaGroup) (*models.ClaGroup, error)
 	GetCLAGroupByID(ctx context.Context, claGroupID string, loadRepoDetails bool) (*models.ClaGroup, error)
+	GetCLAGroupByIDCompat(ctx context.Context, claGroupID string, loadRepoDetails bool) (*models.ClaGroup, error)
 	GetCLAGroupsByExternalID(ctx context.Context, params *project.GetProjectsByExternalIDParams, loadRepoDetails bool) (*models.ClaGroups, error)
 	GetCLAGroupByName(ctx context.Context, claGroupName string) (*models.ClaGroup, error)
 	GetExternalCLAGroup(ctx context.Context, claGroupExternalID string) (*models.ClaGroup, error)
@@ -149,7 +150,7 @@ func (repo *repo) CreateCLAGroup(ctx context.Context, claGroupModel *models.ClaG
 	return claGroupModel, nil
 }
 
-func (repo *repo) getCLAGroupByID(ctx context.Context, claGroupID string, loadCLAGroupDetails bool) (*models.ClaGroup, error) {
+func (repo *repo) getCLAGroupByID(ctx context.Context, claGroupID string, loadCLAGroupDetails bool, claEnabledDefaultIsTrue bool) (*models.ClaGroup, error) {
 	f := logrus.Fields{
 		"functionName":       "project.repository.getCLAGroupByID",
 		utils.XREQUESTID:     ctx.Value(utils.XREQUESTID),
@@ -188,19 +189,36 @@ func (repo *repo) getCLAGroupByID(ctx context.Context, claGroupID string, loadCL
 		return nil, &utils.CLAGroupNotFound{CLAGroupID: claGroupID}
 	}
 	var dbModel models2.DBProjectModel
-	err = dynamodbattribute.UnmarshalMap(results.Items[0], &dbModel)
+	rawItem := results.Items[0]
+	err = dynamodbattribute.UnmarshalMap(rawItem, &dbModel)
 	if err != nil {
 		log.WithFields(f).Warnf("error unmarshalling db cla group model, error: %+v", err)
 		return nil, err
 	}
+	if claEnabledDefaultIsTrue {
+		// If missing, assume true like Pynamo default=True
+		if _, ok := rawItem["project_icla_enabled"]; !ok {
+			dbModel.ProjectIclaEnabled = true
+		}
+		if _, ok := rawItem["project_ccla_enabled"]; !ok {
+			dbModel.ProjectCclaEnabled = true
+		}
+	}
 
 	// Convert the database model to an API response model
 	return repo.buildCLAGroupModel(ctx, dbModel, loadCLAGroupDetails), nil
 }
 
 // GetCLAGroupByID returns the cla group model associated for the specified claGroupID
 func (repo *repo) GetCLAGroupByID(ctx context.Context, claGroupID string, loadRepoDetails bool) (*models.ClaGroup, error) {
-	return repo.getCLAGroupByID(ctx, claGroupID, loadRepoDetails)
+	return repo.getCLAGroupByID(ctx, claGroupID, loadRepoDetails, false)
+}
+
+// GetCLAGroupByIDCompat returns the cla group model associated for the specified claGroupID
+func (repo *repo) GetCLAGroupByIDCompat(ctx context.Context, claGroupID string, loadRepoDetails bool) (*models.ClaGroup, error) {
+	// Uses compatible mode (with python v2): claEnabledDefaultIsTrue - means if project_ccla_enabled or project_icla_enabled
+	// aren't set on dynamoDB item - they will default to true as in Py V2 API
+	return repo.getCLAGroupByID(ctx, claGroupID, loadRepoDetails, true)
 }
 
 // GetCLAGroupsByExternalID queries the database and returns a list of the cla groups
@@ -383,7 +401,7 @@ func (repo *repo) GetClaGroupByProjectSFID(ctx context.Context, projectSFID stri
 
 	log.WithFields(f).Debugf("found CLA Group ID: %s for project SFID: %s", claGroupProject.ClaGroupID, projectSFID)
 
-	return repo.getCLAGroupByID(ctx, claGroupProject.ClaGroupID, loadRepoDetails)
+	return repo.getCLAGroupByID(ctx, claGroupProject.ClaGroupID, loadRepoDetails, false)
 }
 
 // GetCLAGroupByName returns the project model associated for the specified project name

cla-backend-go/project/mocks/mock_service.go

@@ -30,6 +30,7 @@ type Service interface {
 	CreateCLAGroup(ctx context.Context, project *models.ClaGroup) (*models.ClaGroup, error)
 	GetCLAGroups(ctx context.Context, params *project.GetProjectsParams) (*models.ClaGroups, error)
 	GetCLAGroupByID(ctx context.Context, claGroupID string) (*models.ClaGroup, error)
+	GetCLAGroupByIDCompat(ctx context.Context, claGroupID string) (*models.ClaGroup, error)
 	GetCLAGroupsByExternalSFID(ctx context.Context, projectSFID string) (*models.ClaGroups, error)
 	GetCLAGroupsByExternalID(ctx context.Context, params *project.GetProjectsByExternalIDParams) (*models.ClaGroups, error)
 	GetCLAGroupByName(ctx context.Context, projectName string) (*models.ClaGroup, error)
@@ -75,6 +76,16 @@ func (s ProjectService) GetCLAGroups(ctx context.Context, params *project.GetPro
 
 // GetCLAGroupByID service method
 func (s ProjectService) GetCLAGroupByID(ctx context.Context, claGroupID string) (*models.ClaGroup, error) {
+	return s.getCLAGroupByID(ctx, claGroupID, false)
+}
+
+// GetCLAGroupByIDCompat service method
+func (s ProjectService) GetCLAGroupByIDCompat(ctx context.Context, claGroupID string) (*models.ClaGroup, error) {
+	return s.getCLAGroupByID(ctx, claGroupID, true)
+}
+
+// getCLAGroupByID service method
+func (s ProjectService) getCLAGroupByID(ctx context.Context, claGroupID string, claEnabledDefaultIsTrue bool) (*models.ClaGroup, error) {
 	f := logrus.Fields{
 		"functionName":    "GetCLAGroupByID",
 		utils.XREQUESTID:  ctx.Value(utils.XREQUESTID),
@@ -83,7 +94,15 @@ func (s ProjectService) GetCLAGroupByID(ctx context.Context, claGroupID string)
 	}
 
 	log.WithFields(f).Debug("locating CLA Group by ID...")
-	project, err := s.repo.GetCLAGroupByID(ctx, claGroupID, repository.LoadRepoDetails)
+	var (
+		project *models.ClaGroup
+		err     error
+	)
+	if claEnabledDefaultIsTrue {
+		project, err = s.repo.GetCLAGroupByIDCompat(ctx, claGroupID, repository.LoadRepoDetails)
+	} else {
+		project, err = s.repo.GetCLAGroupByID(ctx, claGroupID, repository.LoadRepoDetails)
+	}
 	if err != nil {
 		return nil, err
 	}

cla-backend-go/project/repository/repository.go

@@ -349,7 +349,7 @@ func Configure(api *operations.EasyclaAPI, service v1Project.Service, v2Service
 			"projectID":      params.ProjectID,
 		}
 
-		proj, err := service.GetCLAGroupByID(ctx, params.ProjectID)
+		proj, err := service.GetCLAGroupByIDCompat(ctx, params.ProjectID)
 		if err != nil {
 			if err.Error() == projectDoesNotExist {
 				return project.NewGetProjectCompatNotFound().WithXRequestID(reqID).WithPayload(errorResponse(reqID, err))
@@ -448,8 +448,6 @@ func buildCompatProject(project *v1Models.ClaGroup, projectClaGroups []*projects
 			GitlabRepos:    gitlabRepos,
 		})
 	}
-	// fmt.Printf("GERRITS: %+v\n", *project.Gerrits[0])
-	// fmt.Printf("GITHUBS: %+v\n", *project.GithubRepositories[0])
 	return &models.ProjectCompat{
 		FoundationSfid:                   project.FoundationSFID,
 		ProjectName:                      project.ProjectName,

cla-backend-go/project/service/service.go

@@ -6,6 +6,7 @@
 2) Start `golang` API backend:
 - `` source setenv.sh; cd cla-backend-go; make swagger; make build-linux ``.
 - `` PORT=5001 AUTH0_USERNAME_CLAIM_CLI='http://lfx.dev/claims/username' AUTH0_EMAIL_CLAIM_CLI='http://lfx.dev/claims/email' AUTH0_NAME_CLAIM_CLI='http://lfx.dev/claims/username' ./bin/cla ``.
+- Or: `` ../utils/run_go_api_server.sh ``.
 
 3) Get `auth0` token from browser session (login using `LFID`):
 - `` ./get_oauth_token.sh ``. Copy the token value.
@@ -18,3 +19,5 @@
 - `` MAX_PARALLEL=8 PY_API_URL=https://api.lfcla.dev.platform.linuxfoundation.org go test -v -run '^TestAllProjectsCompatAPI$' ``.
 - To run a specific test case(s): `` DEBUG=1 PROJECT_UUID=88ee12de-122b-4c46-9046-19422054ed8d PY_API_URL=https://api.lfcla.dev.platform.linuxfoundation.org go test -v -run '^TestProjectCompatAPI$' ``.
 - Manually via `cURL`: `` curl -s -XGET http://127.0.0.1:5001/v4/project-compat/01af041c-fa69-4052-a23c-fb8c1d3bef24 | jq . ``.
+- To manually see given project values if APIs differ (to dewbug): `` aws --region us-east-1 --profile lfproduct-dev dynamodb get-item --table-name cla-dev-projects --key '{"project_id": {"S": "4a855799-0aea-4e01-98b7-ef3da09df478"}}' | jq '.Item' ``.
+- And `` aws --region us-east-1 --profile lfproduct-dev dynamodb query --table-name cla-dev-projects-cla-groups --index-name cla-group-id-index --key-condition-expression "cla_group_id = :project_id" --expression-attribute-values '{":project_id":{"S":"4a855799-0aea-4e01-98b7-ef3da09df478"}}' | jq '.Items' ``.

cla-backend-go/v2/project/handlers.go

@@ -146,13 +146,17 @@ func compareMappedFields(t *testing.T, pyData, goData map[string]interface{}, ke
 
 		if okPyTime && okGoTime {
 			if !pyTime.Equal(goTime) {
-				t.Errorf("Datetime mismatch for key '%s' (Go: '%s'): %s != %s", pyKey, goKey, pyTime, goTime)
+				t.Errorf("Datetime mismatch for key '%s' (Go: '%s'): py:%s != go:%s", pyKey, goKey, pyTime, goTime)
 			}
 			continue
 		}
 
+		if (pyVal == nil && goVal == "") || (goVal == nil && pyVal == "") {
+			continue
+		}
+
 		if fmt.Sprint(pyVal) != fmt.Sprint(goVal) {
-			t.Errorf("Mismatch for key '%s' (Go: '%s'): %v != %v", pyKey, goKey, pyVal, goVal)
+			t.Errorf("Mismatch for key '%s' (Go: '%s'): py:%+v != go:%+v", pyKey, goKey, pyVal, goVal)
 		}
 	}
 }
@@ -256,13 +260,17 @@ func compareNestedFields(t *testing.T, pyData, goData, keyMapping map[string]int
 
 		if okPyTime && okGoTime {
 			if !pyTime.Equal(goTime) {
-				t.Errorf("Datetime mismatch for key '%s': %s != %s", k, pyTime, goTime)
+				t.Errorf("Datetime mismatch for key '%s': py:%s != go:%s", k, pyTime, goTime)
 			}
 			continue
 		}
 
+		if (pyVal == nil && goVal == "") || (goVal == nil && pyVal == "") {
+			continue
+		}
+
 		if fmt.Sprint(pyVal) != fmt.Sprint(goVal) {
-			t.Errorf("Mismatch for key '%s': %v != %v", k, pyVal, goVal)
+			t.Errorf("Mismatch for key '%s': py:%+v != go:%+v", k, pyVal, goVal)
 		}
 	}
 }

tests/py2go/README.md

@@ -0,0 +1,2 @@
+#!/bin/bash
+make build-linux && PORT=5001 AUTH0_USERNAME_CLAIM_CLI='http://lfx.dev/claims/username' AUTH0_EMAIL_CLAIM_CLI='http://lfx.dev/claims/email' AUTH0_NAME_CLAIM_CLI='http://lfx.dev/claims/username' ./bin/cla