You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by GitBox <gi...@apache.org> on 2022/11/11 06:39:40 UTC
[GitHub] [incubator-devlake] klesh commented on a diff in pull request #3679: feat: add project api and tables
klesh commented on code in PR #3679:
URL: https://github.com/apache/incubator-devlake/pull/3679#discussion_r1019875460
##########
api/project/project.go:
##########
@@ -0,0 +1,226 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package project
+
+import (
+ "net/http"
+
+ "github.com/apache/incubator-devlake/api/shared"
+ "github.com/apache/incubator-devlake/errors"
+ "github.com/apache/incubator-devlake/models"
+ "github.com/apache/incubator-devlake/services"
+ "github.com/gin-gonic/gin"
+)
+
+// @Summary Create and run a new project
+// @Description Create and run a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [get]
+func GetProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ project, err := services.GetProject(projectName)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error getting project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusOK)
+}
+
+// @Summary Get list of projects
+// @Description GET /projects?page=1&pagesize=10
+// @Tags framework/projects
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} gin.H
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects [get]
+func GetProjects(c *gin.Context) {
+ var query services.ProjectQuery
+ err := c.ShouldBindQuery(&query)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+ projects, count, err := services.GetProjects(&query)
+ if err != nil {
+ shared.ApiOutputAbort(c, errors.Default.Wrap(err, "error getting projects"))
+ return
+ }
+ shared.ApiOutputSuccess(c, gin.H{"project": projects, "count": count}, http.StatusOK)
+}
+
+// @Summary Create a new project
+// @Description Create a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects [post]
+func PostProject(c *gin.Context) {
+ project := &models.Project{}
+
+ err := c.ShouldBind(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ err = services.CreateProject(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error creating project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Summary Patch a project
+// @Description Patch a project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [patch]
+func PatchProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ var body map[string]interface{}
+ err := c.ShouldBind(&body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ project, err := services.PatchProject(projectName, body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error patch project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Cancel a project
+// @Description Cancel a project
+// @Tags framework/projects
+// @Success 200
+// @Failure 400 {string} er2rcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects/:projectName [delete]
+//func DeleteProject(c *gin.Context) {
+//}
+
+// @Summary Get a ProjectMetrics
+// @Description Get a ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /project_metrics/:projectName/:pluginName [get]
+func GetProjectMetric(c *gin.Context) {
+ projectName := c.Param("projectName")
+ pluginName := c.Param("pluginName")
+
+ projectMetric, err := services.GetProjectMetric(projectName, pluginName)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error getting project metric"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, projectMetric, http.StatusOK)
+}
+
+// @Summary Create a new ProjectMetrics
+// @Description Create a new ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /project_metrics [post]
+func PostProjectMetrics(c *gin.Context) {
Review Comment:
Same as above, it can work, but not standard way of RESTful API
##########
api/project/project.go:
##########
@@ -0,0 +1,226 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package project
+
+import (
+ "net/http"
+
+ "github.com/apache/incubator-devlake/api/shared"
+ "github.com/apache/incubator-devlake/errors"
+ "github.com/apache/incubator-devlake/models"
+ "github.com/apache/incubator-devlake/services"
+ "github.com/gin-gonic/gin"
+)
+
+// @Summary Create and run a new project
+// @Description Create and run a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [get]
+func GetProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ project, err := services.GetProject(projectName)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error getting project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusOK)
+}
+
+// @Summary Get list of projects
+// @Description GET /projects?page=1&pagesize=10
+// @Tags framework/projects
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} gin.H
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects [get]
+func GetProjects(c *gin.Context) {
+ var query services.ProjectQuery
+ err := c.ShouldBindQuery(&query)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+ projects, count, err := services.GetProjects(&query)
+ if err != nil {
+ shared.ApiOutputAbort(c, errors.Default.Wrap(err, "error getting projects"))
+ return
+ }
+ shared.ApiOutputSuccess(c, gin.H{"project": projects, "count": count}, http.StatusOK)
+}
+
+// @Summary Create a new project
+// @Description Create a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects [post]
+func PostProject(c *gin.Context) {
+ project := &models.Project{}
+
+ err := c.ShouldBind(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ err = services.CreateProject(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error creating project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Summary Patch a project
+// @Description Patch a project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [patch]
+func PatchProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ var body map[string]interface{}
+ err := c.ShouldBind(&body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ project, err := services.PatchProject(projectName, body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error patch project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Cancel a project
+// @Description Cancel a project
+// @Tags framework/projects
+// @Success 200
+// @Failure 400 {string} er2rcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects/:projectName [delete]
+//func DeleteProject(c *gin.Context) {
+//}
+
+// @Summary Get a ProjectMetrics
+// @Description Get a ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /project_metrics/:projectName/:pluginName [get]
+func GetProjectMetric(c *gin.Context) {
+ projectName := c.Param("projectName")
+ pluginName := c.Param("pluginName")
+
+ projectMetric, err := services.GetProjectMetric(projectName, pluginName)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error getting project metric"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, projectMetric, http.StatusOK)
+}
+
+// @Summary Create a new ProjectMetrics
+// @Description Create a new ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /project_metrics [post]
+func PostProjectMetrics(c *gin.Context) {
+ projectMetric := &models.ProjectMetric{}
+
+ err := c.ShouldBind(projectMetric)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ err = services.CreateProjectMetric(projectMetric)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error creating project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, projectMetric, http.StatusCreated)
+}
+
+// @Summary Patch a ProjectMetrics
+// @Description Patch a ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Accept application/json
+// @Param ProjectMetrics body models.ProjectMetric true "json"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /project_metrics/:projectName/:pluginName [patch]
+func PatchProjectMetrics(c *gin.Context) {
Review Comment:
same as above
##########
api/router.go:
##########
@@ -58,7 +59,22 @@ func RegisterRouter(r *gin.Engine) {
r.POST("/push/:tableName", push.Post)
r.GET("/domainlayer/repos", domainlayer.ReposIndex)
+ // plugin api
r.GET("/plugininfo", plugininfo.Get)
+ r.GET("/plugins", plugininfo.GetPluginNames)
+
+ // project api
+ r.GET("/projects/:projectName", project.GetProject)
+ r.PATCH("/projects/:projectName", project.PatchProject)
+ //r.DELETE("/projects/:projectName", project.DeleteProject)
+ r.POST("/projects", project.PostProject)
+ r.GET("/projects", project.GetProjects)
+
+ // project metric api
+ r.GET("/project_metrics/:projectName/:pluginName", project.GetProjectMetric)
+ r.PATCH("/project_metrics/:projectName/:pluginName", project.PatchProjectMetrics)
+ //r.DELETE("/project_metrics/:projectName/:pluginName", project.DeleteProjectMetrics)
+ r.POST("/project_metrics", project.PostProjectMetrics)
Review Comment:
Same as above
##########
plugins/core/plugin_metric.go:
##########
@@ -0,0 +1,49 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package core
+
+import (
+ "github.com/apache/incubator-devlake/errors"
+)
+
+/*
+ */
+type Tabler interface {
+ TableName() string
+}
+
+type PluginMetric interface {
+ // returns a list of required data entities and expected features.
+ // [{ "model": "cicd_tasks", "requiredFields": {"column": "type", "execptedValue": "Deployment"}}, ...]
+ RequiredDataEntities() (data []map[string]interface{}, err errors.Error)
+
+ // This method returns all models of the current plugin
Review Comment:
This belongs to another interface I believe...
It is for another purpose, we don't need it here.
##########
api/plugininfo/plugininifo.go:
##########
@@ -178,3 +179,24 @@ func Get(c *gin.Context) {
shared.ApiOutputSuccess(c, info, http.StatusOK)
}
+
+// @Get name list of plugins
+// @Description GET /plugins
+// @Description RETURN SAMPLE
+// @Tags framework/plugins
+// @Success 200
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Router /plugins [get]
Review Comment:
This is not enough, we should output more to help `config-ui` renders interfaces.
Please check the prototype, config-ui obviously need to know whether a plugin is `Data Source` plugin or `Metric` plugin.
So, we should output an object array instead of plain names.
if a plugin implemented `PlugMetric` interface, it should contains a field named `metric`
##########
api/router.go:
##########
@@ -58,7 +59,22 @@ func RegisterRouter(r *gin.Engine) {
r.POST("/push/:tableName", push.Post)
r.GET("/domainlayer/repos", domainlayer.ReposIndex)
+ // plugin api
r.GET("/plugininfo", plugininfo.Get)
+ r.GET("/plugins", plugininfo.GetPluginNames)
+
+ // project api
+ r.GET("/projects/:projectName", project.GetProject)
+ r.PATCH("/projects/:projectName", project.PatchProject)
+ //r.DELETE("/projects/:projectName", project.DeleteProject)
+ r.POST("/projects", project.PostProject)
+ r.GET("/projects", project.GetProjects)
+
+ // project metric api
+ r.GET("/project_metrics/:projectName/:pluginName", project.GetProjectMetric)
+ r.PATCH("/project_metrics/:projectName/:pluginName", project.PatchProjectMetrics)
Review Comment:
Same as above
##########
api/project/project.go:
##########
@@ -0,0 +1,226 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package project
+
+import (
+ "net/http"
+
+ "github.com/apache/incubator-devlake/api/shared"
+ "github.com/apache/incubator-devlake/errors"
+ "github.com/apache/incubator-devlake/models"
+ "github.com/apache/incubator-devlake/services"
+ "github.com/gin-gonic/gin"
+)
+
+// @Summary Create and run a new project
+// @Description Create and run a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [get]
+func GetProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ project, err := services.GetProject(projectName)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error getting project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusOK)
+}
+
+// @Summary Get list of projects
+// @Description GET /projects?page=1&pagesize=10
+// @Tags framework/projects
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} gin.H
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects [get]
+func GetProjects(c *gin.Context) {
+ var query services.ProjectQuery
+ err := c.ShouldBindQuery(&query)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+ projects, count, err := services.GetProjects(&query)
+ if err != nil {
+ shared.ApiOutputAbort(c, errors.Default.Wrap(err, "error getting projects"))
+ return
+ }
+ shared.ApiOutputSuccess(c, gin.H{"project": projects, "count": count}, http.StatusOK)
+}
+
+// @Summary Create a new project
+// @Description Create a new project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects [post]
+func PostProject(c *gin.Context) {
+ project := &models.Project{}
+
+ err := c.ShouldBind(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ err = services.CreateProject(project)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error creating project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Summary Patch a project
+// @Description Patch a project
+// @Tags framework/projects
+// @Accept application/json
+// @Param project body models.Project true "json"
+// @Success 200 {object} models.Project
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /projects/:projectName [patch]
+func PatchProject(c *gin.Context) {
+ projectName := c.Param("projectName")
+
+ var body map[string]interface{}
+ err := c.ShouldBind(&body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.BadInput.Wrap(err, shared.BadRequestBody))
+ return
+ }
+
+ project, err := services.PatchProject(projectName, body)
+ if err != nil {
+ shared.ApiOutputError(c, errors.Default.Wrap(err, "error patch project"))
+ return
+ }
+
+ shared.ApiOutputSuccess(c, project, http.StatusCreated)
+}
+
+// @Cancel a project
+// @Description Cancel a project
+// @Tags framework/projects
+// @Success 200
+// @Failure 400 {string} er2rcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /projects/:projectName [delete]
+//func DeleteProject(c *gin.Context) {
+//}
+
+// @Summary Get a ProjectMetrics
+// @Description Get a ProjectMetrics
+// @Tags framework/ProjectMetrics
+// @Param page query int true "query"
+// @Param pagesize query int true "query"
+// @Success 200 {object} models.ProjectMetric
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internel Error"
+// @Router /project_metrics/:projectName/:pluginName [get]
Review Comment:
According to RESTful spec, it should be `/projects/:projectName/metrics`
##########
api/router.go:
##########
@@ -58,7 +59,22 @@ func RegisterRouter(r *gin.Engine) {
r.POST("/push/:tableName", push.Post)
r.GET("/domainlayer/repos", domainlayer.ReposIndex)
+ // plugin api
r.GET("/plugininfo", plugininfo.Get)
+ r.GET("/plugins", plugininfo.GetPluginNames)
+
+ // project api
+ r.GET("/projects/:projectName", project.GetProject)
+ r.PATCH("/projects/:projectName", project.PatchProject)
+ //r.DELETE("/projects/:projectName", project.DeleteProject)
+ r.POST("/projects", project.PostProject)
+ r.GET("/projects", project.GetProjects)
+
+ // project metric api
+ r.GET("/project_metrics/:projectName/:pluginName", project.GetProjectMetric)
Review Comment:
Same as above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org