Feature new getProject endpoint

Signed-off-by: Rafael Raposo <[email protected]>
flyteorg · Feb 2, 2024 · 2c328f6 · 2c328f6
1 parent aedde59
commit 2c328f6
Show file tree

Hide file tree

Showing 17 changed files with 1,479 additions and 42 deletions.
diff --git a/flyteadmin/pkg/manager/impl/project_manager.go b/flyteadmin/pkg/manager/impl/project_manager.go
@@ -127,6 +127,18 @@ func (m *ProjectManager) UpdateProject(ctx context.Context, projectUpdate admin.
 	return &response, nil
 }
 
+func (m *ProjectManager) GetProject(ctx context.Context, request admin.ProjectRequest) (*admin.Project, error) {
+	projectRequest := request.Project
+
+	projectModel, err := m.db.ProjectRepo().Get(ctx, projectRequest.Id)
+	if err != nil {
+		return nil, err
+	}
+	projectResponse := transformers.FromProjectModel(projectModel, m.getDomains())
+
+	return &projectResponse, nil
+}
+
 func NewProjectManager(db repoInterfaces.Repository, config runtimeInterfaces.Configuration) interfaces.ProjectInterface {
 	return &ProjectManager{
 		db:     db,

diff --git a/flyteadmin/pkg/manager/impl/project_manager_test.go b/flyteadmin/pkg/manager/impl/project_manager_test.go
@@ -278,3 +278,30 @@ func TestProjectManager_UpdateProject_ErrorDueToInvalidProjectName(t *testing.T)
 	})
 	assert.EqualError(t, err, "project_name cannot exceed 64 characters")
 }
+
+func TestGetProject(t *testing.T) {
+	repository := repositoryMocks.NewMockRepository()
+	mockedProject := &admin.Project{Id: project}
+	activeState := int32(admin.Project_ACTIVE)
+	repository.ProjectRepo().(*repositoryMocks.MockProjectRepo).GetFunction = func(ctx context.Context, projectID string) (models.Project, error) {
+
+		return models.Project{
+			BaseModel:   models.BaseModel{},
+			Identifier:  projectID,
+			Name:        "a-mocked-project",
+			Description: "A mocked project",
+			State:       &activeState,
+		}, nil
+	}
+
+	projectManager := NewProjectManager(repository, runtimeMocks.NewMockConfigurationProvider(
+		getMockApplicationConfigForProjectManagerTest(), nil, nil, nil, nil, nil))
+
+	resp, _ := projectManager.GetProject(context.Background(),
+		admin.ProjectRequest{Project: mockedProject})
+
+	assert.Equal(t, mockedProject.Id, resp.Id)
+	assert.Equal(t, "a-mocked-project", resp.Name)
+	assert.Equal(t, "A mocked project", resp.Description)
+	assert.Equal(t, admin.Project_ProjectState(0), resp.State)
+}
diff --git a/flyteadmin/pkg/manager/interfaces/project.go b/flyteadmin/pkg/manager/interfaces/project.go
@@ -11,4 +11,5 @@ type ProjectInterface interface {
 	CreateProject(ctx context.Context, request admin.ProjectRegisterRequest) (*admin.ProjectRegisterResponse, error)
 	ListProjects(ctx context.Context, request admin.ProjectListRequest) (*admin.Projects, error)
 	UpdateProject(ctx context.Context, request admin.Project) (*admin.ProjectUpdateResponse, error)
+	GetProject(ctx context.Context, request admin.ProjectRequest) (*admin.Project, error)
 }
diff --git a/flyteadmin/pkg/manager/mocks/project.go b/flyteadmin/pkg/manager/mocks/project.go
@@ -9,11 +9,13 @@ import (
 type CreateProjectFunc func(ctx context.Context, request admin.ProjectRegisterRequest) (*admin.ProjectRegisterResponse, error)
 type ListProjectFunc func(ctx context.Context, request admin.ProjectListRequest) (*admin.Projects, error)
 type UpdateProjectFunc func(ctx context.Context, request admin.Project) (*admin.ProjectUpdateResponse, error)
+type GetProjectFunc func(ctx context.Context, request admin.ProjectRequest) (*admin.Project, error)
 
 type MockProjectManager struct {
 	listProjectFunc   ListProjectFunc
 	createProjectFunc CreateProjectFunc
 	updateProjectFunc UpdateProjectFunc
+	getProjectFunc    GetProjectFunc
 }
 
 func (m *MockProjectManager) SetCreateProject(createProjectFunc CreateProjectFunc) {
@@ -45,3 +47,14 @@ func (m *MockProjectManager) ListProjects(
 	}
 	return nil, nil
 }
+
+func (m *MockProjectManager) SetGetCallBack(getProjectFunc GetProjectFunc) {
+	m.getProjectFunc = getProjectFunc
+}
+
+func (m *MockProjectManager) GetProject(ctx context.Context, request admin.ProjectRequest) (*admin.Project, error) {
+	if m.getProjectFunc != nil {
+		return m.getProjectFunc(ctx, request)
+	}
+	return nil, nil
+}
diff --git a/flyteadmin/pkg/rpc/adminservice/metrics.go b/flyteadmin/pkg/rpc/adminservice/metrics.go
@@ -61,6 +61,7 @@ type projectEndpointMetrics struct {
 	register util.RequestMetrics
 	list     util.RequestMetrics
 	update   util.RequestMetrics
+	get      util.RequestMetrics
 }
 
 type attributeEndpointMetrics struct {
@@ -176,6 +177,7 @@ func InitMetrics(adminScope promutils.Scope) AdminMetrics {
 			register: util.NewRequestMetrics(adminScope, "register_project"),
 			list:     util.NewRequestMetrics(adminScope, "list_projects"),
 			update:   util.NewRequestMetrics(adminScope, "update_project"),
+			get:      util.NewRequestMetrics(adminScope, "get_project"),
 		},
 		projectAttributesEndpointMetrics: attributeEndpointMetrics{
 			scope:  adminScope,

diff --git a/flyteadmin/pkg/rpc/adminservice/project.go b/flyteadmin/pkg/rpc/adminservice/project.go
@@ -63,3 +63,21 @@ func (m *AdminService) UpdateProject(ctx context.Context, request *admin.Project
 
 	return response, nil
 }
+
+func (m *AdminService) GetProject(ctx context.Context, request *admin.ProjectRequest) (*admin.Project, error) {
+	defer m.interceptPanic(ctx, request)
+	if request == nil {
+		return nil, status.Errorf(codes.InvalidArgument, "Incorrect request, nil requests not allowed")
+	}
+	var response *admin.Project
+	var err error
+	m.Metrics.projectEndpointMetrics.get.Time(func() {
+		response, err = m.ProjectManager.GetProject(ctx, *request)
+	})
+	if err != nil {
+		return nil, util.TransformAndRecordError(err, &m.Metrics.projectEndpointMetrics.list)
+	}
+
+	m.Metrics.projectEndpointMetrics.list.Success()
+	return response, nil
+}
diff --git a/flyteadmin/pkg/rpc/adminservice/tests/project_test.go b/flyteadmin/pkg/rpc/adminservice/tests/project_test.go
@@ -58,3 +58,15 @@ func TestListProjects(t *testing.T) {
 	assert.Nil(t, err)
 	assert.True(t, proto.Equal(projects, resp))
 }
+
+func TestGetProject(t *testing.T) {
+	mockProjectManager := mocks.MockProjectManager{}
+	project := &admin.Project{Id: "project id", Name: "project"}
+	mockProjectManager.SetGetCallBack(func(ctx context.Context, request admin.ProjectRequest) (*admin.Project, error) {
+		assert.NotNil(t, request)
+		return project, nil
+	})
+	resp, err := mockProjectManager.GetProject(context.Background(), admin.ProjectRequest{})
+	assert.Nil(t, err)
+	assert.True(t, proto.Equal(project, resp))
+}