odo init json output

docs/website/versioned_docs/version-3.0.0/command-reference/json-output.md

@@ -21,23 +21,70 @@ from the devfiles in the registries defined in the list of preferred registries
 
 The output of this command contains a devfile name and a registry name:
 
-```
+```bash
 $ odo alizer -o json
 {
     "devfile": "nodejs",
-    "registry": "DefaultDevfileRegistry"
+    "devfileRegistry": "DefaultDevfileRegistry"
 }
 $ echo $?
 0
 ```
 
-If the command is executed in an empty directory, it will return an error and terminate with a non-zero exit status:
+If the command is executed in an empty directory, it will return an error in the standard error stream and terminate with a non-zero exit status:
 
-```
+```bash
 $ odo alizer -o json
 {
 	"message": "No valid devfile found for project in /home/user/my/empty/directory"
 }
 $ echo $?
 1
 ```
+
+## odo init -o json
+
+The `init` command downloads a devfile and, optionally, a starter project. The usage for this command can be found in the [odo init command reference page](init.md).
+
+The output of this command contains the path of the downloaded devfile and its content, in JSON format.
+
+```bash
+$ odo init -o json \
+    --name aname \
+    --devfile go \
+    --starter go-starter
+{
+	"devfilePath": "/home/user/my-project/devfile.yaml",
+	"devfileData": {
+		"devfile": {
+			"schemaVersion": "2.1.0",
+      [...]
+		},
+		"supportedOdoFeatures": {
+			"dev": true,
+			"deploy": false,
+			"debug": false
+		}
+	},
+	"forwardedPorts": [],
+	"runningIn": [],
+	"managedBy": "odo"
+}
+$ echo $?
+0
+```
+
+If the command fails, it will return an error in the standard error stream and terminate with a non-zero exit status:
+
+```bash
+# Executing the same command again will fail
+$ odo init -o json \
+    --name aname \
+    --devfile go \
+    --starter go-starter
+{
+	"message": "a devfile already exists in the current directory"
+}
+$ echo $?
+1
+```

pkg/alizer/alizer.go

@@ -4,6 +4,7 @@ import (
 	"reflect"
 
 	"github.com/redhat-developer/alizer/go/pkg/apis/recognizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/registry"
 )
 
@@ -50,8 +51,8 @@ func (o *Alizer) DetectFramework(path string) (recognizer.DevFileType, registry.
 	return typ, registry, nil
 }
 
-func GetDevfileLocationFromDetection(typ recognizer.DevFileType, registry registry.Registry) *DevfileLocation {
-	return &DevfileLocation{
+func GetDevfileLocationFromDetection(typ recognizer.DevFileType, registry registry.Registry) *api.DevfileLocation {
+	return &api.DevfileLocation{
 		Devfile:         typ.Name,
 		DevfileRegistry: registry.Name,
 	}

pkg/api/component.go

@@ -0,0 +1,24 @@
+package api
+
+type RunningMode string
+
+const (
+	RunninModeDev     = "Dev"
+	RunninModeDeploy  = "Deploy"
+	RunninModeUnknown = "Unknown"
+)
+
+// Component describes the state of a devfile component
+type Component struct {
+	DevfilePath    string          `json:"devfilePath"`
+	DevfileData    DevfileData     `json:"devfileData"`
+	ForwardedPorts []ForwardedPort `json:"forwardedPorts"`
+	RunningIn      []RunningMode   `json:"runningIn"`
+	ManagedBy      string          `json:"managedBy"`
+}
+
+type ForwardedPort struct {
+	ContainerName string `json:"containerName"`
+	LocalPort     int    `json:"localPort"`
+	ContainerPort int    `json:"containerPort"`
+}

pkg/api/devfile-data.go

@@ -0,0 +1,16 @@
+package api
+
+import "github.com/devfile/library/pkg/devfile/parser/data"
+
+// DevfileData describes a devfile content
+type DevfileData struct {
+	Devfile              data.DevfileData     `json:"devfile"`
+	SupportedOdoFeatures SupportedOdoFeatures `json:"supportedOdoFeatures"`
+}
+
+// SupportedOdoFeatures indicates the support of high-level (odo) features by a devfile component
+type SupportedOdoFeatures struct {
+	Dev    bool `json:"dev"`
+	Deploy bool `json:"deploy"`
+	Debug  bool `json:"debug"`
+}

pkg/alizer/types.go → pkg/api/devfile-location.go

@@ -1,12 +1,13 @@
-package alizer
+package api
 
+// DevfileLocation indicates the location of a devfile, either in a devfile registry or using a path or an URI
 type DevfileLocation struct {
 	// name of the Devfile in Devfile registry (required if DevfilePath is not defined)
 	Devfile string `json:"devfile,omitempty"`
 
 	// name of the devfile registry (as configured in odo registry). It can be used in combination with Devfile, but not with DevfilePath (optional)
-	DevfileRegistry string `json:"devfile-registry,omitempty"`
+	DevfileRegistry string `json:"devfileRegistry,omitempty"`
 
 	// path to a devfile. This is alternative to using devfile from Devfile registry. It can be local filesystem path or http(s) URL (required if Devfile is not defined)
-	DevfilePath string `json:"devfile-path,omitempty"`
+	DevfilePath string `json:"devfilePath,omitempty"`
 }

pkg/api/doc.go

@@ -0,0 +1,3 @@
+// package api contains structures returned by commands as JSON
+// and utilities to build values of these structures
+package api

pkg/api/utils.go

@@ -0,0 +1,22 @@
+package api
+
+import (
+	"github.com/devfile/library/pkg/devfile/parser"
+	"github.com/devfile/library/pkg/devfile/parser/data"
+	"github.com/redhat-developer/odo/pkg/libdevfile"
+)
+
+func GetDevfileData(devfileObj parser.DevfileObj) DevfileData {
+	return DevfileData{
+		Devfile:              devfileObj.Data,
+		SupportedOdoFeatures: getSupportedOdoFeatures(devfileObj.Data),
+	}
+}
+
+func getSupportedOdoFeatures(devfileData data.DevfileData) SupportedOdoFeatures {
+	return SupportedOdoFeatures{
+		Dev:    libdevfile.HasRunCommand(devfileData),
+		Deploy: libdevfile.HasDeployCommand(devfileData),
+		Debug:  libdevfile.HasDebugCommand(devfileData),
+	}
+}

pkg/init/backend/alizer.go

@@ -6,6 +6,7 @@ import (
 	"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/library/pkg/devfile/parser"
 	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/init/asker"
 	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
 )
@@ -27,7 +28,7 @@ func (o *AlizerBackend) Validate(flags map[string]string, fs filesystem.Filesyst
 }
 
 // SelectDevfile calls thz Alizer to detect the devfile and asks for confirmation to the user
-func (o *AlizerBackend) SelectDevfile(flags map[string]string, fs filesystem.Filesystem, dir string) (location *alizer.DevfileLocation, err error) {
+func (o *AlizerBackend) SelectDevfile(flags map[string]string, fs filesystem.Filesystem, dir string) (location *api.DevfileLocation, err error) {
 	selected, registry, err := o.alizerClient.DetectFramework(dir)
 	if err != nil {
 		return nil, err

pkg/init/backend/alizer_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/redhat-developer/alizer/go/pkg/apis/recognizer"
 	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/init/asker"
 	"github.com/redhat-developer/odo/pkg/registry"
 	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
@@ -36,7 +37,7 @@ func TestAlizerBackend_SelectDevfile(t *testing.T) {
 		name         string
 		fields       fields
 		args         args
-		wantLocation *alizer.DevfileLocation
+		wantLocation *api.DevfileLocation
 		wantErr      bool
 	}{
 		{
@@ -61,7 +62,7 @@ func TestAlizerBackend_SelectDevfile(t *testing.T) {
 				fs:  filesystem.DefaultFs{},
 				dir: GetTestProjectPath("nodejs"),
 			},
-			wantLocation: &alizer.DevfileLocation{
+			wantLocation: &api.DevfileLocation{
 				Devfile:         "a-devfile-name",
 				DevfileRegistry: "a-registry",
 			},

pkg/init/backend/flags.go

@@ -9,7 +9,7 @@ import (
 	"github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	dfutil "github.com/devfile/library/pkg/util"
 
-	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/devfile/location"
 	"github.com/redhat-developer/odo/pkg/preference"
 	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
@@ -69,8 +69,8 @@ func (o *FlagsBackend) Validate(flags map[string]string, fs filesystem.Filesyste
 	return nil
 }
 
-func (o *FlagsBackend) SelectDevfile(flags map[string]string, _ filesystem.Filesystem, _ string) (*alizer.DevfileLocation, error) {
-	return &alizer.DevfileLocation{
+func (o *FlagsBackend) SelectDevfile(flags map[string]string, _ filesystem.Filesystem, _ string) (*api.DevfileLocation, error) {
+	return &api.DevfileLocation{
 		Devfile:         flags[FLAG_DEVFILE],
 		DevfileRegistry: flags[FLAG_DEVFILE_REGISTRY],
 		DevfilePath:     flags[FLAG_DEVFILE_PATH],

pkg/init/backend/flags_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/devfile/library/pkg/devfile/parser/data"
 	dffilesystem "github.com/devfile/library/pkg/testingutil/filesystem"
 
-	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/preference"
 	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
 )
@@ -24,7 +24,7 @@ func TestFlagsBackend_SelectDevfile(t *testing.T) {
 	tests := []struct {
 		name    string
 		fields  fields
-		want    *alizer.DevfileLocation
+		want    *api.DevfileLocation
 		wantErr bool
 	}{
 		{
@@ -37,7 +37,7 @@ func TestFlagsBackend_SelectDevfile(t *testing.T) {
 				},
 			},
 			wantErr: false,
-			want: &alizer.DevfileLocation{
+			want: &api.DevfileLocation{
 				Devfile:         "adevfile",
 				DevfilePath:     "apath",
 				DevfileRegistry: "aregistry",

pkg/init/backend/interactive.go

@@ -10,7 +10,7 @@ import (
 	parsercommon "github.com/devfile/library/pkg/devfile/parser/data/v2/common"
 	"github.com/fatih/color"
 
-	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/init/asker"
 	"github.com/redhat-developer/odo/pkg/log"
 	"github.com/redhat-developer/odo/pkg/registry"
@@ -40,8 +40,8 @@ func (o *InteractiveBackend) Validate(flags map[string]string, fs filesystem.Fil
 	return nil
 }
 
-func (o *InteractiveBackend) SelectDevfile(flags map[string]string, _ filesystem.Filesystem, _ string) (*alizer.DevfileLocation, error) {
-	result := &alizer.DevfileLocation{}
+func (o *InteractiveBackend) SelectDevfile(flags map[string]string, _ filesystem.Filesystem, _ string) (*api.DevfileLocation, error) {
+	result := &api.DevfileLocation{}
 	devfileEntries, _ := o.registryClient.ListDevfileStacks("")
 
 	langs := devfileEntries.GetLanguages()

pkg/init/backend/interactive_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/golang/mock/gomock"
 
-	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/init/asker"
 	"github.com/redhat-developer/odo/pkg/registry"
 	"github.com/redhat-developer/odo/pkg/testingutil"
@@ -26,7 +26,7 @@ func TestInteractiveBackend_SelectDevfile(t *testing.T) {
 	tests := []struct {
 		name    string
 		fields  fields
-		want    *alizer.DevfileLocation
+		want    *api.DevfileLocation
 		wantErr bool
 	}{
 		{
@@ -49,7 +49,7 @@ func TestInteractiveBackend_SelectDevfile(t *testing.T) {
 					return client
 				},
 			},
-			want: &alizer.DevfileLocation{
+			want: &api.DevfileLocation{
 				Devfile:         "a-devfile-name",
 				DevfileRegistry: "MyRegistry1",
 			},
@@ -76,7 +76,7 @@ func TestInteractiveBackend_SelectDevfile(t *testing.T) {
 					return client
 				},
 			},
-			want: &alizer.DevfileLocation{
+			want: &api.DevfileLocation{
 				Devfile:         "a-devfile-name",
 				DevfileRegistry: "MyRegistry1",
 			},

pkg/init/backend/interface.go

@@ -6,7 +6,7 @@ package backend
 import (
 	"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	"github.com/devfile/library/pkg/devfile/parser"
-	"github.com/redhat-developer/odo/pkg/alizer"
+	"github.com/redhat-developer/odo/pkg/api"
 	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
 )
 
@@ -16,7 +16,7 @@ type InitBackend interface {
 	Validate(flags map[string]string, fs filesystem.Filesystem, dir string) error
 
 	// SelectDevfile selects a devfile and returns its location information, depending on the flags
-	SelectDevfile(flags map[string]string, fs filesystem.Filesystem, dir string) (location *alizer.DevfileLocation, err error)
+	SelectDevfile(flags map[string]string, fs filesystem.Filesystem, dir string) (location *api.DevfileLocation, err error)
 
 	// SelectStarterProject selects a starter project from the devfile and returns information about the starter project,
 	// depending on the flags. If not starter project is selected, a nil starter is returned