Function ModuleSetup

pkg/modules/setup/setup.go:30–57

* Module Setup This module is used to set up the connection to a remote host and gather facts about it. It performs the following operations: 1. Establishes a connection to the specified host using the appropriate connector 2. If the connector supports fact gathering (implements GatherFacts interfa

(ctx context.Context, opts internal.ExecOptions)

// ModuleSetup establishes a connection to a remote host and gathers facts about it.
// It returns StdoutSuccess if successful, or an error message if any step fails.
func ModuleSetup(ctx context.Context, opts internal.ExecOptions) (string, string, error) {
	ha, err := opts.GetAllVariables()
	if err != nil {
		return internal.StdoutFailed, internal.StderrGetHostVariable, err
	}
	args := variable.Extension2Variables(opts.Args)
	if force, err := variable.BoolVar(ha, args, "force"); err == nil && *force {
		ctx = context.WithValue(ctx, _const.CTXSetupForceKey, true)
	}
	// get connector
	conn, err := opts.GetConnector(ctx)
	if err != nil {
		return internal.StdoutFailed, internal.StderrGetConnector, nil
	}
	defer conn.Close(ctx)

	if gf, ok := conn.(connector.GatherFacts); ok {
		remoteInfo, err := gf.HostInfo(ctx)
		if err != nil {
			return internal.StdoutFailed, "failed to get host info", err
		}
		if err := opts.Merge(variable.MergeRemoteVariable(remoteInfo, opts.Host)); err != nil {
			return internal.StdoutFailed, "failed to merge setup variable", err
		}
	}

	return internal.StdoutSuccess, "", nil
}