github.com/sleungcy-sap/cli@v7.1.0+incompatible/cf/commands/application/unset_env.go (about)

     1  package application
     2  
     3  import (
     4  	"fmt"
     5  
     6  	"code.cloudfoundry.org/cli/cf"
     7  	"code.cloudfoundry.org/cli/cf/api/applications"
     8  	"code.cloudfoundry.org/cli/cf/commandregistry"
     9  	"code.cloudfoundry.org/cli/cf/configuration/coreconfig"
    10  	"code.cloudfoundry.org/cli/cf/flags"
    11  	. "code.cloudfoundry.org/cli/cf/i18n"
    12  	"code.cloudfoundry.org/cli/cf/models"
    13  	"code.cloudfoundry.org/cli/cf/requirements"
    14  	"code.cloudfoundry.org/cli/cf/terminal"
    15  )
    16  
    17  type UnsetEnv struct {
    18  	ui      terminal.UI
    19  	config  coreconfig.Reader
    20  	appRepo applications.Repository
    21  	appReq  requirements.ApplicationRequirement
    22  }
    23  
    24  func init() {
    25  	commandregistry.Register(&UnsetEnv{})
    26  }
    27  
    28  func (cmd *UnsetEnv) SetDependency(deps commandregistry.Dependency, pluginCall bool) commandregistry.Command {
    29  	cmd.ui = deps.UI
    30  	cmd.config = deps.Config
    31  	cmd.appRepo = deps.RepoLocator.GetApplicationRepository()
    32  	return cmd
    33  }
    34  
    35  func (cmd *UnsetEnv) MetaData() commandregistry.CommandMetadata {
    36  	return commandregistry.CommandMetadata{
    37  		Name:        "unset-env",
    38  		ShortName:   "ue",
    39  		Description: T("Remove an env variable from an app"),
    40  		Usage: []string{
    41  			T("CF_NAME unset-env APP_NAME ENV_VAR_NAME"),
    42  		},
    43  	}
    44  }
    45  
    46  func (cmd *UnsetEnv) Requirements(requirementsFactory requirements.Factory, fc flags.FlagContext) ([]requirements.Requirement, error) {
    47  	if len(fc.Args()) != 2 {
    48  		cmd.ui.Failed(T("Incorrect Usage. Requires 'app-name env-name' as arguments\n\n") + commandregistry.Commands.CommandUsage("unset-env"))
    49  		return nil, fmt.Errorf("Incorrect usage: %d arguments of %d required", len(fc.Args()), 2)
    50  	}
    51  
    52  	cmd.appReq = requirementsFactory.NewApplicationRequirement(fc.Args()[0])
    53  
    54  	reqs := []requirements.Requirement{
    55  		requirementsFactory.NewLoginRequirement(),
    56  		requirementsFactory.NewTargetedSpaceRequirement(),
    57  		cmd.appReq,
    58  	}
    59  
    60  	return reqs, nil
    61  }
    62  
    63  func (cmd *UnsetEnv) Execute(c flags.FlagContext) error {
    64  	varName := c.Args()[1]
    65  	app := cmd.appReq.GetApplication()
    66  
    67  	cmd.ui.Say(T("Removing env variable {{.VarName}} from app {{.AppName}} in org {{.OrgName}} / space {{.SpaceName}} as {{.CurrentUser}}...",
    68  		map[string]interface{}{
    69  			"VarName":     terminal.EntityNameColor(varName),
    70  			"AppName":     terminal.EntityNameColor(app.Name),
    71  			"OrgName":     terminal.EntityNameColor(cmd.config.OrganizationFields().Name),
    72  			"SpaceName":   terminal.EntityNameColor(cmd.config.SpaceFields().Name),
    73  			"CurrentUser": terminal.EntityNameColor(cmd.config.Username())}))
    74  
    75  	envParams := app.EnvironmentVars
    76  
    77  	if _, ok := envParams[varName]; !ok {
    78  		cmd.ui.Ok()
    79  		cmd.ui.Warn(T("Env variable {{.VarName}} was not set.", map[string]interface{}{"VarName": varName}))
    80  		return nil
    81  	}
    82  
    83  	delete(envParams, varName)
    84  
    85  	_, err := cmd.appRepo.Update(app.GUID, models.AppParams{EnvironmentVars: &envParams})
    86  	if err != nil {
    87  		return err
    88  	}
    89  
    90  	cmd.ui.Ok()
    91  	cmd.ui.Say(T("TIP: Use '{{.Command}}' to ensure your env variable changes take effect",
    92  		map[string]interface{}{"Command": terminal.CommandColor(cf.Name + " restage")}))
    93  	return nil
    94  }