Skip to content

Commit

Permalink
display equivalent odo init command for odo init interactive
Browse files Browse the repository at this point in the history 
Signed-off-by: anandrkskd <anandrkskd@gmail.com>
  • Loading branch information
@anandrkskd
anandrkskd committed Oct 26, 2022
1 parent 5a41b26 commit 414bb53
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 21 deletions.
14 changes: 7 additions & 7 deletions pkg/init/init.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,27 +254,27 @@ func (o InitClient) PersonalizeDevfileConfig(devfileobj parser.DevfileObj, flags
return backend.PersonalizeDevfileConfig(devfileobj)
}

func (o InitClient) SelectAndPersonalizeDevfile(flags map[string]string, contextDir string) (parser.DevfileObj, string, error) {
func (o InitClient) SelectAndPersonalizeDevfile(flags map[string]string, contextDir string) (parser.DevfileObj, string, *api.DevfileLocation, error) {
devfileLocation, err := o.SelectDevfile(flags, o.fsys, contextDir)
if err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", nil, err
}

devfilePath, err := o.DownloadDevfile(devfileLocation, contextDir)
if err != nil {
return parser.DevfileObj{}, "", fmt.Errorf("unable to download devfile: %w", err)
return parser.DevfileObj{}, "", nil, fmt.Errorf("unable to download devfile: %w", err)
}

devfileObj, _, err := devfile.ParseDevfileAndValidate(parser.ParserArgs{Path: devfilePath, FlattenedDevfile: pointer.BoolPtr(false)})
if err != nil {
return parser.DevfileObj{}, "", fmt.Errorf("unable to parse devfile: %w", err)
return parser.DevfileObj{}, "", nil, fmt.Errorf("unable to parse devfile: %w", err)
}

devfileObj, err = o.PersonalizeDevfileConfig(devfileObj, flags, o.fsys, contextDir)
if err != nil {
return parser.DevfileObj{}, "", fmt.Errorf("failed to configure devfile: %w", err)
return parser.DevfileObj{}, "", nil, fmt.Errorf("failed to configure devfile: %w", err)
}
return devfileObj, devfilePath, nil
return devfileObj, devfilePath, devfileLocation, nil
}

func (o InitClient) InitDevfile(flags map[string]string, contextDir string,
Expand All @@ -292,7 +292,7 @@ func (o InitClient) InitDevfile(flags map[string]string, contextDir string,
preInitHandlerFunc(len(flags) == 0)
}

devfileObj, _, err := o.SelectAndPersonalizeDevfile(map[string]string{}, contextDir)
devfileObj, _, _, err := o.SelectAndPersonalizeDevfile(map[string]string{}, contextDir)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/init/interface.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ type Client interface {

// SelectAndPersonalizeDevfile selects a devfile, then downloads, parse and personalize it
// Returns the devfile object and its path
SelectAndPersonalizeDevfile(flags map[string]string, contextDir string) (parser.DevfileObj, string, error)
SelectAndPersonalizeDevfile(flags map[string]string, contextDir string) (parser.DevfileObj, string, *api.DevfileLocation, error)
}
33 changes: 20 additions & 13 deletions pkg/odo/cli/init/init.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/spf13/cobra"

"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
"github.com/devfile/library/pkg/devfile"
"github.com/devfile/library/pkg/devfile/parser"

Expand Down Expand Up @@ -113,7 +114,7 @@ func (o *InitOptions) Validate(ctx context.Context) error {
// Run contains the logic for the odo command
func (o *InitOptions) Run(ctx context.Context) (err error) {

devfileObj, _, err := o.run(ctx)
devfileObj, _, name, devfileLocation, starterInfo, err := o.run(ctx)
if err != nil {
return err
}
Expand All @@ -123,6 +124,12 @@ Your new component '%s' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.`, devfileObj.Data.GetMetadata().Name)

if len(o.flags) == 0 && starterInfo != nil {
log.Infof("\n\nYou can automate this command by executing:\n odo init --name %s --devfile %s --devfile-registry %s --starter %s", name, devfileLocation.Devfile, devfileLocation.DevfileRegistry, starterInfo.Name)
} else if len(o.flags) == 0 {
log.Infof("\n\nYou can automate this command by executing:\n odo init --name %s --devfile %s --devfile-registry %s", name, devfileLocation.Devfile, devfileLocation.DevfileRegistry)
}

if libdevfile.HasDeployCommand(devfileObj.Data) {
exitMessage += "\nTo deploy your component to a cluster use \"odo deploy\"."
}
Expand All @@ -133,7 +140,7 @@ Changes will be directly reflected on the cluster.`, devfileObj.Data.GetMetadata

// RunForJsonOutput is executed instead of Run when -o json flag is given
func (o *InitOptions) RunForJsonOutput(ctx context.Context) (out interface{}, err error) {
devfileObj, devfilePath, err := o.run(ctx)
devfileObj, devfilePath, _, _, _, err := o.run(ctx)
if err != nil {
return nil, err
}
Expand All @@ -147,7 +154,7 @@ func (o *InitOptions) RunForJsonOutput(ctx context.Context) (out interface{}, er
}

// run downloads the devfile and starter project and returns the content and the path of the devfile
func (o *InitOptions) run(ctx context.Context) (devfileObj parser.DevfileObj, path string, err error) {
func (o *InitOptions) run(ctx context.Context) (devfileObj parser.DevfileObj, path string, name string, devfileLocation *api.DevfileLocation, starterInfoName *v1alpha2.StarterProject, err error) {
var starterDownloaded bool

workingDir := odocontext.GetWorkingDirectory(ctx)
Expand All @@ -166,7 +173,7 @@ func (o *InitOptions) run(ctx context.Context) (devfileObj parser.DevfileObj, pa

isEmptyDir, err := location.DirIsEmpty(o.clientset.FS, workingDir)
if err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", "", nil, nil, err
}

// Show a welcome message for when you initially run `odo init`.
Expand All @@ -183,49 +190,49 @@ func (o *InitOptions) run(ctx context.Context) (devfileObj parser.DevfileObj, pa
log.Info(messages.InteractiveModeEnabled)
}

devfileObj, devfilePath, err := o.clientset.InitClient.SelectAndPersonalizeDevfile(o.flags, workingDir)
devfileObj, devfilePath, devfileLocation, err := o.clientset.InitClient.SelectAndPersonalizeDevfile(o.flags, workingDir)
if err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", "", nil, nil, err
}

starterInfo, err := o.clientset.InitClient.SelectStarterProject(devfileObj, o.flags, o.clientset.FS, workingDir)
if err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", "", nil, nil, err
}

// Set the name in the devfile but do not write it yet to disk,
// because the starter project downloaded at the end might come bundled with a specific Devfile.
name, err := o.clientset.InitClient.PersonalizeName(devfileObj, o.flags)
name, err = o.clientset.InitClient.PersonalizeName(devfileObj, o.flags)
if err != nil {
return parser.DevfileObj{}, "", fmt.Errorf("failed to update the devfile's name: %w", err)
return parser.DevfileObj{}, "", "", nil, nil, fmt.Errorf("failed to update the devfile's name: %w", err)
}

if starterInfo != nil {
// WARNING: this will remove all the content of the destination directory, ie the devfile.yaml file
err = o.clientset.InitClient.DownloadStarterProject(starterInfo, workingDir)
if err != nil {
return parser.DevfileObj{}, "", fmt.Errorf("unable to download starter project %q: %w", starterInfo.Name, err)
return parser.DevfileObj{}, "", "", nil, nil, fmt.Errorf("unable to download starter project %q: %w", starterInfo.Name, err)
}
starterDownloaded = true

// in case the starter project contains a devfile, read it again
if _, err = o.clientset.FS.Stat(devfilePath); err == nil {
devfileObj, _, err = devfile.ParseDevfileAndValidate(parser.ParserArgs{Path: devfilePath, FlattenedDevfile: pointer.BoolPtr(false)})
if err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", "", nil, nil, err
}
}
}
// WARNING: SetMetadataName writes the Devfile to disk
if err = devfileObj.SetMetadataName(name); err != nil {
return parser.DevfileObj{}, "", err
return parser.DevfileObj{}, "", "", nil, nil, err
}
scontext.SetComponentType(ctx, component.GetComponentTypeFromDevfileMetadata(devfileObj.Data.GetMetadata()))
scontext.SetLanguage(ctx, devfileObj.Data.GetMetadata().Language)
scontext.SetProjectType(ctx, devfileObj.Data.GetMetadata().ProjectType)
scontext.SetDevfileName(ctx, devfileObj.GetMetadataName())

return devfileObj, devfilePath, nil
return devfileObj, devfilePath, name, devfileLocation, starterInfo, nil
}

// NewCmdInit implements the odo command
Expand Down

0 comments on commit 414bb53

Please sign in to comment.