Merge pull request #2053 from afumagalli98/2046

feat: add ListLocationsLicenses endpoint to APIService

Author: afumagalli98

api-service/controller/controller.go

@@ -71,6 +71,7 @@ type APIControllerInterface interface {
 
 	// ListLocations list locations using the filters in the request
 	ListLocations(w http.ResponseWriter, r *http.Request)
+	ListLocationsLicenses(w http.ResponseWriter, r *http.Request)
 	// ListEnvironments list environments using the filters in the request
 	ListEnvironments(w http.ResponseWriter, r *http.Request)
 	// GetHostsCountStats return the number of the hosts using the filters in the request

api-service/controller/hosts.go

@@ -248,6 +248,18 @@ func (ctrl *APIController) ListLocations(w http.ResponseWriter, r *http.Request)
 	utils.WriteJSONResponse(w, http.StatusOK, locations)
 }
 
+func (ctrl *APIController) ListLocationsLicenses(w http.ResponseWriter, r *http.Request) {
+	user := context.Get(r, "user")
+
+	locations, err := ctrl.Service.ListLocationsLicenses(user)
+	if err != nil {
+		utils.WriteAndLogError(ctrl.Log, w, http.StatusInternalServerError, err)
+		return
+	}
+
+	utils.WriteJSONResponse(w, http.StatusOK, locations)
+}
+
 // ListEnvironments list the environments using the filters in the request
 func (ctrl *APIController) ListEnvironments(w http.ResponseWriter, r *http.Request) {
 	var location, environment string

api-service/controller/routing.go

@@ -119,6 +119,8 @@ func (ctrl *APIController) setupProtectedRoutes(router *mux.Router) {
 	router.HandleFunc("/hosts/technologies/all/databases/licenses-used-per-cluster", ctrl.GetUsedLicensesPerCluster).Methods("GET")
 	router.HandleFunc("/hosts/technologies/all/databases/licenses-compliance", ctrl.GetDatabaseLicensesCompliance).Methods("GET")
 
+	router.HandleFunc("/hosts/technologies/all/databases/licenses/locations", ctrl.ListLocationsLicenses).Methods("GET")
+
 	router.HandleFunc("/hosts/technologies/all/databases/grant-dba", ctrl.ListOracleGrantDbaByHostname).Methods("GET")
 
 	// ORACLE

api-service/service/hosts.go

@@ -446,6 +446,29 @@ func (as *APIService) ListLocations(user interface{}) ([]string, error) {
 	return as.Database.GetUserLocations(u.Username)
 }
 
+func (as *APIService) ListLocationsLicenses(user interface{}) ([]string, error) {
+	locations, err := as.ListLocations(user)
+	if err != nil {
+		return nil, err
+	}
+
+	if as.Config.APIService.ScopeAsLocation != "" {
+		mergedLocations := make([]string, 0)
+		mergedLocations = append(mergedLocations, as.Config.APIService.ScopeAsLocation)
+		scopes := strings.Split(as.Config.APIService.ScopeAsLocation, ",")
+
+		for _, location := range locations {
+			if !utils.ContainsI(scopes, location) {
+				mergedLocations = append(mergedLocations, location)
+			}
+		}
+
+		return mergedLocations, nil
+	}
+
+	return locations, nil
+}
+
 // ListEnvironments list environments
 func (as *APIService) ListEnvironments(location string, environment string, olderThan time.Time) ([]string, error) {
 	return as.Database.ListEnvironments(location, environment, olderThan)

api-service/service/hosts_test.go

@@ -1114,3 +1114,100 @@ func TestGetVirtualHostWithoutCluster_Success(t *testing.T) {
 
 	assert.Equal(t, expected, actual)
 }
+
+func TestListLocationsLicenses(t *testing.T) {
+	testCases := []struct {
+		name          string
+		config        config.Configuration
+		user          model.User
+		buildStubs    func(db *MockMongoDatabaseInterface)
+		checkResponse func(t *testing.T, res []string, err error)
+	}{
+		{
+			name: "Ok user",
+			config: config.Configuration{
+				APIService: config.APIService{
+					ScopeAsLocation: "loc1,loc2,loc3",
+				},
+			},
+			user: model.User{
+				Username: "user01",
+			},
+			buildStubs: func(db *MockMongoDatabaseInterface) {
+				db.EXPECT().GetUserLocations("user01").
+					Return([]string{"loc1", "loc2", "loc3", "loc4"}, nil)
+			},
+
+			checkResponse: func(t *testing.T, res []string, err error) {
+				assert.NoError(t, err)
+				assert.NotEmpty(t, res)
+				expectedResult := []string{"loc1,loc2,loc3", "loc4"}
+				assert.Equal(t, expectedResult, res)
+			},
+		},
+		{
+			name: "Ok Admin",
+			config: config.Configuration{
+				APIService: config.APIService{
+					ScopeAsLocation: "loc1,loc2,loc3",
+				},
+			},
+			user: model.User{
+				Username: "user01",
+				Groups:   []string{"admin"},
+			},
+			buildStubs: func(db *MockMongoDatabaseInterface) {
+				db.EXPECT().ListAllLocations("", "", utils.MAX_TIME).
+					Return([]string{"loc1", "loc2", "loc3", "loc4"}, nil)
+			},
+
+			checkResponse: func(t *testing.T, res []string, err error) {
+				assert.NoError(t, err)
+				assert.NotEmpty(t, res)
+				expectedResult := []string{"loc1,loc2,loc3", "loc4"}
+				assert.Equal(t, expectedResult, res)
+			},
+		},
+		{
+			name: "ScopeAsLocation empty",
+			config: config.Configuration{
+				APIService: config.APIService{
+					ScopeAsLocation: "",
+				},
+			},
+			user: model.User{
+				Username: "user01",
+			},
+			buildStubs: func(db *MockMongoDatabaseInterface) {
+				db.EXPECT().GetUserLocations("user01").
+					Return([]string{"loc1", "loc2", "loc3", "loc4"}, nil)
+			},
+
+			checkResponse: func(t *testing.T, res []string, err error) {
+				assert.NoError(t, err)
+				assert.NotEmpty(t, res)
+				expectedResult := []string{"loc1", "loc2", "loc3", "loc4"}
+				assert.Equal(t, expectedResult, res)
+			},
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+
+			mockCtrl := gomock.NewController(t)
+			defer mockCtrl.Finish()
+			db := NewMockMongoDatabaseInterface(mockCtrl)
+
+			as := APIService{
+				Database: db,
+				Config:   tc.config,
+			}
+
+			tc.buildStubs(db)
+
+			res, err := as.ListLocationsLicenses(tc.user)
+
+			tc.checkResponse(t, res, err)
+		})
+	}
+}

api-service/service/service.go

@@ -86,6 +86,7 @@ type APIServiceInterface interface {
 	ListAllLocations(location string, environment string, olderThan time.Time) ([]string, error)
 	// ListLocations list locations
 	ListLocations(user interface{}) ([]string, error)
+	ListLocationsLicenses(user interface{}) ([]string, error)
 	// ListEnvironments list environments
 	ListEnvironments(location string, environment string, olderThan time.Time) ([]string, error)
 

swagger.yml

@@ -4129,6 +4129,25 @@ paths:
           $ref: "#/components/responses/error"
         "500":
           $ref: "#/components/responses/error"
+
+  /hosts/technologies/all/databases/licenses/locations:
+    get:
+      tags:
+        - api-service
+      operationId: ListLocationsLicenses
+      summary: List locations using config.ScopeAsLocation
+      description: List locations using config.ScopeAsLocation
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+                uniqueItems: true
+
   /hosts/environments:
     get:
       tags: