pulumi/pkg/cmd/pulumi/plugin.go

113 lines
3.8 KiB
Go

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"github.com/spf13/cobra"
"github.com/pulumi/pulumi/pkg/v3/engine"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/cmdutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
)
func newPluginCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "plugin",
Short: "Manage language and resource provider plugins",
Long: "Manage language and resource provider plugins.\n" +
"\n" +
"Pulumi uses dynamically loaded plugins as an extensibility mechanism for\n" +
"supporting any number of languages and resource providers. These plugins are\n" +
"distributed out of band and must be installed manually. Attempting to use a\n" +
"package that provisions resources without the corresponding plugin will fail.\n" +
"\n" +
"You may write your own plugins, for example to implement custom languages or\n" +
"resources, although most people will never need to do this. To understand how to\n" +
"write and distribute your own plugins, please consult the relevant documentation.\n" +
"\n" +
"The plugin family of commands provides a way of explicitly managing plugins.",
Args: cmdutil.NoArgs,
}
cmd.AddCommand(newPluginInstallCmd())
cmd.AddCommand(newPluginLsCmd())
cmd.AddCommand(newPluginRmCmd())
return cmd
}
// getProjectPlugins fetches a list of plugins used by this project.
func getProjectPlugins() ([]workspace.PluginSpec, error) {
proj, root, err := readProject()
if err != nil {
return nil, err
}
projinfo := &engine.Projinfo{Proj: proj, Root: root}
pwd, main, ctx, err := engine.ProjectInfoContext(projinfo, nil, cmdutil.Diag(), cmdutil.Diag(), false, nil)
if err != nil {
return nil, err
}
defer ctx.Close()
// Get the required plugins and then ensure they have metadata populated about them. Because it's possible
// a plugin required by the project hasn't yet been installed, we will simply skip any errors we encounter.
plugins, err := plugin.GetRequiredPlugins(ctx.Host, ctx.Root, plugin.ProgInfo{
Proj: proj,
Pwd: pwd,
Program: main,
}, plugin.AllPlugins)
if err != nil {
return nil, err
}
return plugins, nil
}
func resolvePlugins(plugins []workspace.PluginSpec) ([]workspace.PluginInfo, error) {
proj, root, err := readProject()
if err != nil {
return nil, err
}
projinfo := &engine.Projinfo{Proj: proj, Root: root}
_, _, ctx, err := engine.ProjectInfoContext(projinfo, nil, cmdutil.Diag(), cmdutil.Diag(), false, nil)
if err != nil {
return nil, err
}
defer ctx.Close()
// Get the required plugins and then ensure they have metadata populated about them. Because it's possible
// a plugin required by the project hasn't yet been installed, we will simply skip any errors we encounter.
var results []workspace.PluginInfo
for _, plugin := range plugins {
info, err := workspace.GetPluginInfo(plugin.Kind, plugin.Name, plugin.Version, ctx.Host.GetProjectPlugins())
if err != nil {
err = info.SetFileMetadata(info.Path)
if err != nil {
return nil, err
}
contract.IgnoreError(err)
}
if info != nil {
results = append(results, *info)
}
}
return results, nil
}