2022-05-20 11:29:10 -04:00
package cli
import (
2023-03-16 17:17:48 +01:00
"encoding/json"
"fmt"
2022-05-20 11:29:10 -04:00
"os"
2023-08-09 13:00:25 +02:00
"strings"
2022-05-20 11:29:10 -04:00
"golang.org/x/xerrors"
"gopkg.in/yaml.v3"
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-05-20 11:29:10 -04:00
)
2023-08-09 13:00:25 +02:00
// workspaceParameterFlags are used by commands processing rich parameters and/or build options.
type workspaceParameterFlags struct {
2024-10-16 23:54:12 +02:00
promptEphemeralParameters bool
ephemeralParameters [] string
2022-05-20 11:29:10 -04:00
2024-04-29 11:23:54 -07:00
richParameterFile string
richParameters [] string
richParameterDefaults [] string
2023-11-02 14:41:34 -05:00
promptRichParameters bool
}
2024-03-15 11:24:38 -05:00
func ( wpf * workspaceParameterFlags ) allOptions () [] serpent . Option {
2024-10-16 23:54:12 +02:00
options := append ( wpf . cliEphemeralParameters (), wpf . cliParameters () ... )
2024-04-29 11:23:54 -07:00
options = append ( options , wpf . cliParameterDefaults () ... )
2023-11-02 14:41:34 -05:00
return append ( options , wpf . alwaysPrompt ())
2022-05-20 11:29:10 -04:00
}
2024-10-16 23:54:12 +02:00
func ( wpf * workspaceParameterFlags ) cliEphemeralParameters () [] serpent . Option {
2024-03-15 11:24:38 -05:00
return serpent . OptionSet {
2024-10-16 23:54:12 +02:00
// Deprecated - replaced with ephemeral-parameter
2023-08-09 13:00:25 +02:00
{
Flag : "build-option" ,
Env : "CODER_BUILD_OPTION" ,
Description : `Build option value in the format "name=value".` ,
2024-10-16 23:54:12 +02:00
UseInstead : [] serpent . Option {{ Flag : "ephemeral-parameter" }},
Value : serpent . StringArrayOf ( & wpf . ephemeralParameters ),
2023-08-09 13:00:25 +02:00
},
2024-10-16 23:54:12 +02:00
// Deprecated - replaced with prompt-ephemeral-parameters
2023-08-09 13:00:25 +02:00
{
Flag : "build-options" ,
Description : "Prompt for one-time build options defined with ephemeral parameters." ,
2024-10-16 23:54:12 +02:00
UseInstead : [] serpent . Option {{ Flag : "prompt-ephemeral-parameters" }},
Value : serpent . BoolOf ( & wpf . promptEphemeralParameters ),
},
{
Flag : "ephemeral-parameter" ,
Env : "CODER_EPHEMERAL_PARAMETER" ,
Description : `Set the value of ephemeral parameters defined in the template. The format is "name=value".` ,
Value : serpent . StringArrayOf ( & wpf . ephemeralParameters ),
},
{
Flag : "prompt-ephemeral-parameters" ,
Env : "CODER_PROMPT_EPHEMERAL_PARAMETERS" ,
Description : "Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for." ,
Value : serpent . BoolOf ( & wpf . promptEphemeralParameters ),
2023-08-09 13:00:25 +02:00
},
}
}
2024-03-15 11:24:38 -05:00
func ( wpf * workspaceParameterFlags ) cliParameters () [] serpent . Option {
return serpent . OptionSet {
serpent . Option {
2023-08-09 13:00:25 +02:00
Flag : "parameter" ,
Env : "CODER_RICH_PARAMETER" ,
Description : `Rich parameter value in the format "name=value".` ,
2024-03-15 11:24:38 -05:00
Value : serpent . StringArrayOf ( & wpf . richParameters ),
2023-08-09 13:00:25 +02:00
},
2024-03-15 11:24:38 -05:00
serpent . Option {
2023-08-09 13:00:25 +02:00
Flag : "rich-parameter-file" ,
Env : "CODER_RICH_PARAMETER_FILE" ,
2024-10-09 10:04:24 +05:30
Description : "Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters." ,
2024-03-15 11:24:38 -05:00
Value : serpent . StringOf ( & wpf . richParameterFile ),
2023-08-09 13:00:25 +02:00
},
}
}
2024-04-29 11:23:54 -07:00
func ( wpf * workspaceParameterFlags ) cliParameterDefaults () [] serpent . Option {
return serpent . OptionSet {
serpent . Option {
Flag : "parameter-default" ,
Env : "CODER_RICH_PARAMETER_DEFAULT" ,
Description : `Rich parameter default values in the format "name=value".` ,
Value : serpent . StringArrayOf ( & wpf . richParameterDefaults ),
},
}
}
2024-03-15 11:24:38 -05:00
func ( wpf * workspaceParameterFlags ) alwaysPrompt () serpent . Option {
return serpent . Option {
2023-11-02 14:41:34 -05:00
Flag : "always-prompt" ,
Description : "Always prompt all parameters. Does not pull parameter values from existing workspace." ,
2024-03-15 11:24:38 -05:00
Value : serpent . BoolOf ( & wpf . promptRichParameters ),
2023-11-02 14:41:34 -05:00
}
}
2025-07-28 14:46:04 +01:00
func presetParameterAsWorkspaceBuildParameters ( presetParameters [] codersdk . PresetParameter ) [] codersdk . WorkspaceBuildParameter {
var params [] codersdk . WorkspaceBuildParameter
for _ , parameter := range presetParameters {
params = append ( params , codersdk . WorkspaceBuildParameter ( parameter ))
}
return params
}
2023-08-09 13:00:25 +02:00
func asWorkspaceBuildParameters ( nameValuePairs [] string ) ([] codersdk . WorkspaceBuildParameter , error ) {
var params [] codersdk . WorkspaceBuildParameter
for _ , nameValue := range nameValuePairs {
split := strings . SplitN ( nameValue , "=" , 2 )
if len ( split ) < 2 {
return nil , xerrors . Errorf ( "format key=value expected, but got %s" , nameValue )
}
params = append ( params , codersdk . WorkspaceBuildParameter {
Name : split [ 0 ],
Value : split [ 1 ],
})
}
return params , nil
}
func parseParameterMapFile ( parameterFile string ) ( map [ string ] string , error ) {
parameterFileContents , err := os . ReadFile ( parameterFile )
if err != nil {
return nil , err
}
mapStringInterface := make ( map [ string ] interface {})
err = yaml . Unmarshal ( parameterFileContents , & mapStringInterface )
if err != nil {
return nil , err
}
parameterMap := map [ string ] string {}
for k , v := range mapStringInterface {
switch val := v .( type ) {
case string , bool , int :
parameterMap [ k ] = fmt . Sprintf ( "%v" , val )
case [] interface {}:
b , err := json . Marshal ( & val )
2023-01-23 15:01:22 +01:00
if err != nil {
return nil , err
}
2023-08-09 13:00:25 +02:00
parameterMap [ k ] = string ( b )
default :
return nil , xerrors . Errorf ( "invalid parameter type: %T" , v )
2023-01-23 15:01:22 +01:00
}
}
2023-08-09 13:00:25 +02:00
return parameterMap , nil
2023-01-23 15:01:22 +01:00
}
2024-09-04 14:39:35 +01:00
2025-07-22 13:11:27 +02:00
// buildFlags contains options relating to troubleshooting provisioner jobs
// and setting the reason for the workspace build.
2024-09-04 14:39:35 +01:00
type buildFlags struct {
provisionerLogDebug bool
2025-07-22 13:11:27 +02:00
reason string
2024-09-04 14:39:35 +01:00
}
func ( bf * buildFlags ) cliOptions () [] serpent . Option {
return [] serpent . Option {
{
Flag : "provisioner-log-debug" ,
Description : `Sets the provisioner log level to debug.
This will print additional information about the build process.
This is useful for troubleshooting build issues.` ,
Value : serpent . BoolOf ( & bf . provisionerLogDebug ),
Hidden : true ,
},
2025-07-22 13:11:27 +02:00
{
Flag : "reason" ,
Description : `Sets the reason for the workspace build (cli, vscode_connection, jetbrains_connection).` ,
Value : serpent . EnumOf (
& bf . reason ,
string ( codersdk . BuildReasonCLI ),
string ( codersdk . BuildReasonVSCodeConnection ),
string ( codersdk . BuildReasonJetbrainsConnection ),
),
Default : string ( codersdk . BuildReasonCLI ),
Hidden : true ,
},
2024-09-04 14:39:35 +01:00
}
}