Add name detection to odo analyze (#6682)

* Add name detection to odo analyze

Signed-off-by: Parthvi Vala <[email protected]>

* Update tests/helper/helper_generic.go

Co-authored-by: Armel Soro <[email protected]>

* Update tests/integration/cmd_analyze_test.go

Co-authored-by: Armel Soro <[email protected]>

* Update odo analyze documentation

Signed-off-by: Parthvi Vala <[email protected]>

---------

Signed-off-by: Parthvi Vala <[email protected]>
Co-authored-by: Armel Soro <[email protected]>

Author: valaparthvi

docs/website/docs/command-reference/json-output.md

@@ -22,6 +22,7 @@ The structures used to return information using JSON output are defined in [the
 The `analyze` command analyzes the files in the current directory and returns the following information:
 - the best devfiles to use, from the devfiles in the registries defined in the list of preferred registries with the command `odo preference view`
 - the ports used in the application, if that was possible to determine.
+- the name of the application, if that was possible to determine; else it returns name of the current directory.
 
 The output of this command contains a list of devfile name and registry name:
 
@@ -35,7 +36,8 @@ odo analyze -o json
 	    "devfileRegistry": "DefaultDevfileRegistry",
         "ports": [
             3000
-        ]
+        ],
+        "name": "node-echo"
 	}
 ]
 ```

pkg/alizer/alizer.go

@@ -138,11 +138,12 @@ func (o *Alizer) DetectPorts(path string) ([]int, error) {
 	return components[0].Ports, nil
 }
 
-func NewDetectionResult(typ model.DevFileType, registry api.Registry, appPorts []int, devfileVersion string) *api.DetectionResult {
+func NewDetectionResult(typ model.DevFileType, registry api.Registry, appPorts []int, devfileVersion, name string) *api.DetectionResult {
 	return &api.DetectionResult{
 		Devfile:          typ.Name,
 		DevfileRegistry:  registry.Name,
 		ApplicationPorts: appPorts,
 		DevfileVersion:   devfileVersion,
+		Name:             name,
 	}
 }

pkg/api/analyze.go

@@ -17,4 +17,6 @@ type DetectionResult struct {
 	// ApplicationPorts represents the list of ports detected
 	ApplicationPorts []int  `json:"ports,omitempty"`
 	DevfileVersion   string `json:"devfileVersion,omitempty"`
+	// Name represents the project/application name as detected by alizer
+	Name string `json:"name,omitempty"`
 }

pkg/init/backend/alizer.go

@@ -63,7 +63,7 @@ func (o *AlizerBackend) SelectDevfile(ctx context.Context, flags map[string]stri
 	if !confirm {
 		return nil, nil
 	}
-	return alizer.NewDetectionResult(selected, registry, appPorts, defaultVersion), nil
+	return alizer.NewDetectionResult(selected, registry, appPorts, defaultVersion, ""), nil
 }
 
 func (o *AlizerBackend) SelectStarterProject(devfile parser.DevfileObj, flags map[string]string) (starter *v1alpha2.StarterProject, err error) {

pkg/odo/cli/alizer/alizer.go

@@ -58,7 +58,11 @@ func (o *AlizerOptions) RunForJsonOutput(ctx context.Context) (out interface{},
 	if err != nil {
 		return nil, err
 	}
-	result := alizer.NewDetectionResult(df, reg, appPorts, defaultVersion)
+	name, err := o.clientset.AlizerClient.DetectName(workingDir)
+	if err != nil {
+		return nil, err
+	}
+	result := alizer.NewDetectionResult(df, reg, appPorts, defaultVersion, name)
 	return []api.DetectionResult{*result}, nil
 }
 

tests/helper/helper_generic.go

@@ -319,6 +319,12 @@ func JsonPathDoesNotExist(json string, path string) {
 		fmt.Sprintf("content should not contain %q but is %q", path, result.String()))
 }
 
+// JsonPathExist expects that the content of the path exists in the JSON string
+func JsonPathExist(json string, path string) {
+	result := gjson.Get(json, path)
+	Expect(result.Exists()).To(BeTrue(),
+		fmt.Sprintf("content should contain %q", path))
+}
 func JsonPathContentIsValidUserPort(json string, path string) {
 	result := gjson.Get(json, path)
 	intVal, err := strconv.Atoi(result.String())

tests/integration/cmd_analyze_test.go

@@ -30,7 +30,7 @@ var _ = Describe("odo analyze command tests", func() {
 
 			When("source files are in the directory", func() {
 				BeforeEach(func() {
-					helper.CopyExample(filepath.Join("source", "devfiles", "nodejs", "project"), commonVar.Context)
+					helper.CopyExample(filepath.Join("source", "nodejs"), commonVar.Context)
 				})
 
 				It("analyze should return correct value", func() {
@@ -39,7 +39,9 @@ var _ = Describe("odo analyze command tests", func() {
 					Expect(stderr).To(BeEmpty())
 					Expect(helper.IsJSON(stdout)).To(BeTrue())
 					helper.JsonPathContentIs(stdout, "0.devfile", "nodejs")
-					helper.JsonPathContentIs(stdout, "0.devfileRegistry", "DefaultDevfileRegistry")
+					helper.JsonPathExist(stdout, "0.devfileRegistry")
+					helper.JsonPathContentIs(stdout, "0.name", "node-echo")
+					helper.JsonPathExist(stdout, "0.ports")
 				})
 			})