feat: expose the m2k graph file using the API (#110)

Signed-off-by: Harikrishnan Balagopal <[email protected]>

Author: HarikrishnanBalagopal

internal/filesystem/filesystem.go

@@ -1846,6 +1846,68 @@ func (fs *FileSystem) readProjectOutput(t *bolt.Tx, workspaceId, projectId, proj
 	return projOutput, f, nil
 }
 
+// ReadProjectOutputGraph returns the graph file from the target artifacts for an application
+func (fs *FileSystem) ReadProjectOutputGraph(workspaceId, projectId, projOutputId string) (projOutput types.ProjectOutput, file io.Reader, err error) {
+	db, err := fs.GetDatabase(true)
+	if err != nil {
+		return projOutput, file, err
+	}
+	defer db.Close()
+	err = db.View(func(t *bolt.Tx) error {
+		projOutput, file, err = fs.readProjectOutputGraph(t, workspaceId, projectId, projOutputId)
+		return err
+	})
+	return projOutput, file, err
+}
+
+func (fs *FileSystem) readProjectOutputGraph(t *bolt.Tx, workspaceId, projectId, projOutputId string) (projOutput types.ProjectOutput, file io.Reader, err error) {
+	project, err := fs.readProject(t, workspaceId, projectId)
+	if err != nil {
+		return types.ProjectOutput{}, nil, err
+	}
+	projOutput, ok := project.Outputs[projOutputId]
+	if !ok {
+		return projOutput, nil, types.ErrorDoesNotExist{Id: projOutputId}
+	}
+	if projOutput.Status == types.ProjectOutputStatusInProgress {
+		return projOutput, nil, types.ErrorOngoing{Id: projOutputId}
+	}
+	if projOutput.Status != types.ProjectOutputStatusDoneSuccess {
+		if projOutput.Status == types.ProjectOutputStatusDoneError {
+			return projOutput, nil, types.ErrorValidation{Reason: fmt.Sprintf("an error occurred during transformation of the output %s of project %s", projOutputId, projectId)}
+		}
+		return projOutput, nil, types.ErrorDoesNotExist{Id: projOutputId}
+	}
+	curDir := filepath.Join(common.Config.DataDir, PROJECTS_DIR, projectId, PROJECT_OUTPUTS_DIR, projOutputId, "output")
+	if err := fs.processGraph(curDir); err != nil {
+		return projOutput, nil, fmt.Errorf("failed to process the project output graph file inside the output directory %s . Error: %q", curDir, err)
+	}
+	projOutputPath := filepath.Join(curDir, "m2k-proc-graph.json")
+	f, err := os.Open(projOutputPath)
+	if err != nil {
+		return projOutput, nil, fmt.Errorf("failed to read the project output file at path %s . Error: %q", projOutputPath, err)
+	}
+	return projOutput, f, nil
+}
+
+func (fs *FileSystem) processGraph(currentRunDir string) error {
+	logrus.Infof("Starting graph at directory %s", currentRunDir)
+	cmdArgs := []string{"graph", "--output", "m2k-proc-graph.json"}
+	logrus.Infof("graph cmdArgs: %+v", cmdArgs)
+	ctx := context.Background()
+	if common.Config.PlanTimeoutSeconds > 0 {
+		var cancel context.CancelFunc
+		ctx, cancel = context.WithTimeout(ctx, time.Duration(common.Config.PlanTimeoutSeconds)*time.Second)
+		defer cancel()
+	}
+	cmd := exec.CommandContext(ctx, common.APP_NAME, cmdArgs...)
+	cmd.Dir = currentRunDir
+	if err := cmd.Run(); err != nil {
+		return fmt.Errorf("failed to start the graph command. Error: %q", err)
+	}
+	return nil
+}
+
 // DeleteProjectOutput deletes the project output
 func (fs *FileSystem) DeleteProjectOutput(workspaceId, projectId, projOutputId string) error {
 	db, err := fs.GetDatabase(false)

internal/filesystem/interface.go

@@ -47,6 +47,7 @@ type IFileSystem interface {
 	StartTransformation(workspaceId, projectId string, projOutput types.ProjectOutput, plan io.Reader, debugMode bool) error
 	ResumeTransformation(workspaceId, projectId, projOutputId string, debugMode bool) error
 	ReadProjectOutput(workspaceId, projectId, projOutputId string) (projOutput types.ProjectOutput, file io.Reader, err error)
+	ReadProjectOutputGraph(workspaceId, projectId, projOutputId string) (projOutput types.ProjectOutput, file io.Reader, err error)
 	DeleteProjectOutput(workspaceId, projectId, projOutputId string) error
 	GetQuestion(workspaceId, projectId, projOutputId string) (problem string, err error)
 	PostSolution(workspaceId, projectId, projOutputId, solution string) error

internal/move2kubeapi/handlers/outputs.go

@@ -136,6 +136,46 @@ func HandleReadProjectOutput(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// HandleReadProjectOutputGraph handles reading the graph file from the output of a transformation
+func HandleReadProjectOutputGraph(w http.ResponseWriter, r *http.Request) {
+	logrus := GetLogger(r)
+	logrus.Trace("HandleReadProjectOutputGraph start")
+	defer logrus.Trace("HandleReadProjectOutputGraph end")
+	workspaceId := mux.Vars(r)[WORKSPACE_ID_ROUTE_VAR]
+	projectId := mux.Vars(r)[PROJECT_ID_ROUTE_VAR]
+	projOutputId := mux.Vars(r)[PROJECT_OUTPUT_ID_ROUTE_VAR]
+	if !common.IsValidId(workspaceId) || !common.IsValidId(projectId) || !common.IsValidId(projOutputId) {
+		logrus.Errorf("invalid id. Actual: %s %s %s", workspaceId, projectId, projOutputId)
+		sendErrorJSON(w, "invalid id", http.StatusBadRequest)
+		return
+	}
+	_, file, err := m2kFS.ReadProjectOutputGraph(workspaceId, projectId, projOutputId)
+	if err != nil {
+		logrus.Errorf("failed to get the project output. Error: %q", err)
+		if _, ok := err.(types.ErrorDoesNotExist); ok {
+			w.WriteHeader(http.StatusNotFound)
+			return
+		}
+		if e, ok := err.(types.ErrorValidation); ok {
+			sendErrorJSON(w, e.Reason, http.StatusBadRequest)
+			return
+		}
+		if _, ok := err.(types.ErrorOngoing); ok {
+			w.WriteHeader(http.StatusNoContent)
+			return
+		}
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+	w.Header().Set(common.CONTENT_TYPE_HEADER, common.CONTENT_TYPE_JSON)
+	w.WriteHeader(http.StatusOK)
+	if _, err := io.Copy(w, file); err != nil {
+		logrus.Errorf("failed to send the response. Error: %q", err)
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+}
+
 // HandleDeleteProjectOutput handles deleting the output of a transformation
 func HandleDeleteProjectOutput(w http.ResponseWriter, r *http.Request) {
 	logrus := GetLogger(r)

internal/move2kubeapi/move2kubeapi.go

@@ -114,6 +114,9 @@ func Serve() error {
 	apiRouter.HandleFunc("/workspaces/{work-id}/projects/{proj-id}/outputs/{output-id}", handlers.HandleReadProjectOutput).Methods("GET")
 	apiRouter.HandleFunc("/workspaces/{work-id}/projects/{proj-id}/outputs/{output-id}", handlers.HandleDeleteProjectOutput).Methods("DELETE")
 
+	// project output graphs
+	apiRouter.HandleFunc("/workspaces/{work-id}/projects/{proj-id}/outputs/{output-id}/graph", handlers.HandleReadProjectOutputGraph).Methods("GET")
+
 	// QA
 	apiRouter.HandleFunc("/workspaces/{work-id}/projects/{proj-id}/outputs/{output-id}/problems/current", handlers.HandleGetQuestion).Methods("GET")
 	apiRouter.HandleFunc("/workspaces/{work-id}/projects/{proj-id}/outputs/{output-id}/problems/current/solution", handlers.HandlePostSolution).Methods("POST")