2022-03-22 13:17:50 -06:00
package cli
import (
2022-06-24 12:30:22 -04:00
"fmt"
2023-10-19 17:16:15 -05:00
"net/http"
2022-03-22 13:17:50 -06:00
"time"
2023-07-13 12:56:02 +02:00
"golang.org/x/xerrors"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/cli/cliui"
2024-12-02 20:54:32 +00:00
"github.com/coder/coder/v2/cli/cliutil"
2023-08-18 13:55:43 -05:00
"github.com/coder/coder/v2/codersdk"
2024-03-15 11:24:38 -05:00
"github.com/coder/serpent"
2022-03-22 13:17:50 -06:00
)
2024-03-17 09:45:26 -05:00
func ( r * RootCmd ) start () * serpent . Command {
2024-09-04 14:39:35 +01:00
var (
parameterFlags workspaceParameterFlags
bflags buildFlags
2025-03-25 13:54:53 +01:00
noWait bool
2024-09-04 14:39:35 +01:00
)
2023-07-13 12:56:02 +02:00
2023-03-23 17:42:20 -05:00
client := new ( codersdk . Client )
2024-03-17 09:45:26 -05:00
cmd := & serpent . Command {
2022-05-09 17:42:02 -05:00
Annotations : workspaceCommand ,
Use : "start <workspace>" ,
2022-09-19 11:36:18 -05:00
Short : "Start a workspace" ,
2024-03-15 11:24:38 -05:00
Middleware : serpent . Chain (
serpent . RequireNArgs ( 1 ),
2023-03-23 17:42:20 -05:00
r . InitClient ( client ),
),
2025-03-25 13:54:53 +01:00
Options : serpent . OptionSet {
{
Flag : "no-wait" ,
Description : "Return immediately after starting the workspace." ,
Value : serpent . BoolOf ( & noWait ),
Hidden : false ,
},
cliui . SkipPromptOption (),
},
2024-03-15 11:24:38 -05:00
Handler : func ( inv * serpent . Invocation ) error {
2023-03-23 17:42:20 -05:00
workspace , err := namedWorkspace ( inv . Context (), client , inv . Args [ 0 ])
2022-03-22 13:17:50 -06:00
if err != nil {
return err
}
2024-01-03 13:24:37 +04:00
var build codersdk . WorkspaceBuild
switch workspace . LatestBuild . Status {
2024-12-02 20:54:32 +00:00
case codersdk . WorkspaceStatusPending :
// The above check is technically duplicated in cliutil.WarnmatchedProvisioners
// but we still want to avoid users spamming multiple builds that will
// not be picked up.
_ , _ = fmt . Fprintf (
inv . Stdout ,
"\nThe %s workspace is waiting to start!\n" ,
cliui . Keyword ( workspace . Name ),
)
cliutil . WarnMatchedProvisioners ( inv . Stderr , workspace . LatestBuild . MatchedProvisioners , workspace . LatestBuild . Job )
if _ , err := cliui . Prompt ( inv , cliui . PromptOptions {
Text : "Enqueue another start?" ,
IsConfirm : true ,
Default : cliui . ConfirmNo ,
}); err != nil {
return err
}
2024-01-03 13:24:37 +04:00
case codersdk . WorkspaceStatusRunning :
_ , _ = fmt . Fprintf (
inv . Stdout , "\nThe %s workspace is already running!\n" ,
cliui . Keyword ( workspace . Name ),
)
return nil
case codersdk . WorkspaceStatusStarting :
_ , _ = fmt . Fprintf (
inv . Stdout , "\nThe %s workspace is already starting.\n" ,
cliui . Keyword ( workspace . Name ),
)
build = workspace . LatestBuild
default :
2024-09-04 14:39:35 +01:00
build , err = startWorkspace ( inv , client , workspace , parameterFlags , bflags , WorkspaceStart )
2024-01-03 13:24:37 +04:00
// It's possible for a workspace build to fail due to the template requiring starting
// workspaces with the active version.
if cerr , ok := codersdk . AsError ( err ); ok && cerr . StatusCode () == http . StatusForbidden {
2024-01-23 18:01:44 +01:00
_ , _ = fmt . Fprintln ( inv . Stdout , "Unable to start the workspace with the template version from the last build. Policy may require you to restart with the current active template version." )
2024-09-04 14:39:35 +01:00
build , err = startWorkspace ( inv , client , workspace , parameterFlags , bflags , WorkspaceUpdate )
2024-01-03 13:24:37 +04:00
if err != nil {
return xerrors . Errorf ( "start workspace with active template version: %w" , err )
}
} else if err != nil {
return err
2023-10-19 17:16:15 -05:00
}
2022-03-22 13:17:50 -06:00
}
2022-06-24 12:30:22 -04:00
2025-03-25 13:54:53 +01:00
if noWait {
_ , _ = fmt . Fprintf ( inv . Stdout , "The %s workspace has been started in no-wait mode. Workspace is building in the background.\n" , cliui . Keyword ( workspace . Name ))
return nil
}
2023-03-23 17:42:20 -05:00
err = cliui . WorkspaceBuild ( inv . Context (), inv . Stdout , client , build . ID )
2022-06-24 12:30:22 -04:00
if err != nil {
return err
}
2023-09-07 17:28:22 -04:00
_ , _ = fmt . Fprintf (
inv . Stdout , "\nThe %s workspace has been started at %s!\n" ,
cliui . Keyword ( workspace . Name ), cliui . Timestamp ( time . Now ()),
)
2022-06-24 12:30:22 -04:00
return nil
2022-03-22 13:17:50 -06:00
},
}
2023-11-02 14:41:34 -05:00
cmd . Options = append ( cmd . Options , parameterFlags . allOptions () ... )
2024-09-04 14:39:35 +01:00
cmd . Options = append ( cmd . Options , bflags . cliOptions () ... )
2023-11-02 14:41:34 -05:00
2022-05-20 10:59:04 -05:00
return cmd
2022-03-22 13:17:50 -06:00
}
2023-07-13 12:56:02 +02:00
2024-09-04 14:39:35 +01:00
func buildWorkspaceStartRequest ( inv * serpent . Invocation , client * codersdk . Client , workspace codersdk . Workspace , parameterFlags workspaceParameterFlags , buildFlags buildFlags , action WorkspaceCLIAction ) ( codersdk . CreateWorkspaceBuildRequest , error ) {
2023-11-02 14:41:34 -05:00
version := workspace . LatestBuild . TemplateVersionID
2024-01-23 18:01:44 +01:00
2023-11-02 14:41:34 -05:00
if workspace . AutomaticUpdates == codersdk . AutomaticUpdatesAlways || action == WorkspaceUpdate {
version = workspace . TemplateActiveVersionID
if version != workspace . LatestBuild . TemplateVersionID {
action = WorkspaceUpdate
}
2023-07-13 12:56:02 +02:00
}
2023-11-02 14:41:34 -05:00
lastBuildParameters , err := client . WorkspaceBuildParameters ( inv . Context (), workspace . LatestBuild . ID )
2023-07-13 12:56:02 +02:00
if err != nil {
2023-11-02 14:41:34 -05:00
return codersdk . CreateWorkspaceBuildRequest {}, err
2023-07-13 12:56:02 +02:00
}
2024-10-16 23:54:12 +02:00
ephemeralParameters , err := asWorkspaceBuildParameters ( parameterFlags . ephemeralParameters )
2023-10-19 17:16:15 -05:00
if err != nil {
2023-11-02 14:41:34 -05:00
return codersdk . CreateWorkspaceBuildRequest {}, xerrors . Errorf ( "unable to parse build options: %w" , err )
2023-10-19 17:16:15 -05:00
}
2023-11-02 14:41:34 -05:00
cliRichParameters , err := asWorkspaceBuildParameters ( parameterFlags . richParameters )
if err != nil {
2024-04-29 11:23:54 -07:00
return codersdk . CreateWorkspaceBuildRequest {}, xerrors . Errorf ( "unable to parse rich parameters: %w" , err )
}
cliRichParameterDefaults , err := asWorkspaceBuildParameters ( parameterFlags . richParameterDefaults )
if err != nil {
return codersdk . CreateWorkspaceBuildRequest {}, xerrors . Errorf ( "unable to parse rich parameter defaults: %w" , err )
2023-11-02 14:41:34 -05:00
}
2023-10-19 17:16:15 -05:00
2023-11-02 14:41:34 -05:00
buildParameters , err := prepWorkspaceBuild ( inv , client , prepWorkspaceBuildArgs {
Action : action ,
TemplateVersionID : version ,
NewWorkspaceName : workspace . Name ,
LastBuildParameters : lastBuildParameters ,
2023-10-19 17:16:15 -05:00
2024-10-16 23:54:12 +02:00
PromptEphemeralParameters : parameterFlags . promptEphemeralParameters ,
EphemeralParameters : ephemeralParameters ,
PromptRichParameters : parameterFlags . promptRichParameters ,
RichParameters : cliRichParameters ,
RichParameterFile : parameterFlags . richParameterFile ,
RichParameterDefaults : cliRichParameterDefaults ,
2023-10-19 17:16:15 -05:00
})
if err != nil {
2023-11-02 14:41:34 -05:00
return codersdk . CreateWorkspaceBuildRequest {}, err
2023-10-19 17:16:15 -05:00
}
2024-09-04 14:39:35 +01:00
wbr := codersdk . CreateWorkspaceBuildRequest {
2023-10-19 17:16:15 -05:00
Transition : codersdk . WorkspaceTransitionStart ,
RichParameterValues : buildParameters ,
2023-11-02 14:41:34 -05:00
TemplateVersionID : version ,
2024-09-04 14:39:35 +01:00
}
if buildFlags . provisionerLogDebug {
wbr . LogLevel = codersdk . ProvisionerLogLevelDebug
}
2025-07-22 13:11:27 +02:00
if buildFlags . reason != "" {
wbr . Reason = codersdk . CreateWorkspaceBuildReason ( buildFlags . reason )
}
2024-09-04 14:39:35 +01:00
return wbr , nil
2023-11-02 14:41:34 -05:00
}
2024-09-04 14:39:35 +01:00
func startWorkspace ( inv * serpent . Invocation , client * codersdk . Client , workspace codersdk . Workspace , parameterFlags workspaceParameterFlags , buildFlags buildFlags , action WorkspaceCLIAction ) ( codersdk . WorkspaceBuild , error ) {
2024-01-16 16:42:04 -06:00
if workspace . DormantAt != nil {
_ , _ = fmt . Fprintln ( inv . Stdout , "Activating dormant workspace..." )
err := client . UpdateWorkspaceDormancy ( inv . Context (), workspace . ID , codersdk . UpdateWorkspaceDormancy {
Dormant : false ,
})
if err != nil {
return codersdk . WorkspaceBuild {}, xerrors . Errorf ( "activate workspace: %w" , err )
}
}
2024-09-04 14:39:35 +01:00
req , err := buildWorkspaceStartRequest ( inv , client , workspace , parameterFlags , buildFlags , action )
2023-10-19 17:16:15 -05:00
if err != nil {
return codersdk . WorkspaceBuild {}, err
}
2023-11-02 14:41:34 -05:00
build , err := client . CreateWorkspaceBuild ( inv . Context (), workspace . ID , req )
if err != nil {
return codersdk . WorkspaceBuild {}, xerrors . Errorf ( "create workspace build: %w" , err )
}
2024-12-02 20:54:32 +00:00
cliutil . WarnMatchedProvisioners ( inv . Stderr , build . MatchedProvisioners , build . Job )
2023-11-02 14:41:34 -05:00
2023-10-19 17:16:15 -05:00
return build , nil
}