mirror of
https://github.com/hashicorp/packer.git
synced 2026-10-22 14:12:10 -04:00
Lucas Bajolet
3c8a51bdbf
The interface for building a plugin through the test suite was confusing, as it would build the plugin and return its path, cache the path for the version built, and return the path regardless if something was built or not. While in the current state this is harmless as builds are idempotent, since the state of the plugin package/module does not change, this will in the future as we introduce customisation techniques on the plugin's directory and files, making this double-use potentially dangerous. Furthermore, the current behaviour is unclear, as the function hides that caching mechanism, which could come as a surprise for users attempting to build a plugin for the duration of a test, while the built plugin is linked to the test suite being run, and not the unit test being evaluated. Therefore this commit changes the sequence in which plugins are built and used. Now the `CompilePlugin` function builds a plugin, and does not return its path anymore, instead terminating the tests immediately if they fail. In normal test usage, a new `GetPluginPath` function is introduced, which looks-up the path in the suite's cache, failing immediately if invoked before the plugin is built. With this change, it is heavily advised to build plugins when initialising the suite, then in the tests, the GetPluginPath function should be used to get a plugin's path for interacting with packer commands.
107 lines
4.1 KiB
Go
107 lines
4.1 KiB
Go
package plugin_tests
|
|
|
|
import "github.com/hashicorp/packer/packer_test/lib"
|
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginWithMetadata() {
|
|
tempPluginDir, cleanup := ts.MakePluginDir()
|
|
defer cleanup()
|
|
|
|
ts.Run("install plugin with metadata in version", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0+metadata"), "github.com/hashicorp/tester").
|
|
Assert(lib.MustSucceed(), lib.Grep("Successfully installed plugin", lib.GrepStdout))
|
|
})
|
|
|
|
ts.Run("metadata plugin installed must not have metadata in its path", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("plugins", "installed").
|
|
Assert(lib.MustSucceed(), lib.Grep("packer-plugin-tester_v1.0.0[^+]", lib.GrepStdout))
|
|
})
|
|
|
|
ts.Run("plugin with metadata should work with validate", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("validate", "./templates/simple.pkr.hcl").
|
|
Assert(lib.MustSucceed(), lib.Grep("packer-plugin-tester_v1.0.0[^+][^\\n]+plugin:", lib.GrepStderr))
|
|
})
|
|
|
|
ts.Run("plugin with metadata should work with build", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("build", "./templates/simple.pkr.hcl").
|
|
Assert(lib.MustSucceed(), lib.Grep("packer-plugin-tester_v1.0.0[^+][^\\n]+plugin:", lib.GrepStderr))
|
|
})
|
|
}
|
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginWithPath() {
|
|
tempPluginDir, cleanup := ts.MakePluginDir()
|
|
defer cleanup()
|
|
|
|
ts.Run("install plugin with pre-release only", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0-dev"), "github.com/hashicorp/tester").
|
|
Assert(lib.MustSucceed(), lib.Grep("Successfully installed plugin", lib.GrepStdout))
|
|
})
|
|
|
|
ts.Run("install same plugin with pre-release + metadata", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0-dev+metadata"), "github.com/hashicorp/tester").
|
|
Assert(lib.MustSucceed(), lib.Grep("Successfully installed plugin", lib.GrepStdout))
|
|
})
|
|
|
|
ts.Run("list plugins, should only report one plugin", func() {
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
SetArgs("plugins", "installed").
|
|
Assert(lib.MustSucceed(),
|
|
lib.Grep("plugin-tester_v1.0.0-dev[^+]", lib.GrepStdout),
|
|
lib.GrepInverted("plugin-tester_v1.0.0-dev\\+", lib.GrepStdout),
|
|
lib.LineCountCheck(1))
|
|
})
|
|
}
|
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginPrerelease() {
|
|
pluginPath := ts.GetPluginPath(ts.T(), "1.0.1-alpha1")
|
|
|
|
pluginDir, cleanup := ts.MakePluginDir()
|
|
defer cleanup()
|
|
|
|
ts.Run("try install plugin with alpha1 prerelease - should fail", func() {
|
|
ts.PackerCommand().UsePluginDir(pluginDir).
|
|
SetArgs("plugins", "install", "--path", pluginPath, "github.com/hashicorp/tester").
|
|
Assert(lib.MustFail(), lib.Grep("Packer can only install plugin releases with this command", lib.GrepStdout))
|
|
})
|
|
}
|
|
|
|
func (ts *PackerPluginTestSuite) TestRemoteInstallWithPluginsInstall() {
|
|
ts.SkipNoAcc()
|
|
|
|
pluginPath, cleanup := ts.MakePluginDir()
|
|
defer cleanup()
|
|
|
|
ts.Run("install latest version of a remote plugin with packer plugins install", func() {
|
|
ts.PackerCommand().UsePluginDir(pluginPath).
|
|
SetArgs("plugins", "install", "github.com/hashicorp/hashicups").
|
|
Assert(lib.MustSucceed())
|
|
})
|
|
}
|
|
|
|
func (ts *PackerPluginTestSuite) TestRemoteInstallOfPreReleasePlugin() {
|
|
ts.SkipNoAcc()
|
|
|
|
pluginPath, cleanup := ts.MakePluginDir()
|
|
defer cleanup()
|
|
|
|
ts.Run("try to init with a pre-release constraint - should fail", func() {
|
|
ts.PackerCommand().UsePluginDir(pluginPath).
|
|
SetArgs("init", "templates/pre-release_constraint.pkr.hcl").
|
|
Assert(lib.MustFail(),
|
|
lib.Grep("Invalid version constraint", lib.GrepStdout),
|
|
lib.Grep("Unsupported prerelease for constraint", lib.GrepStdout))
|
|
})
|
|
|
|
ts.Run("try to plugins install with a pre-release version - should fail", func() {
|
|
ts.PackerCommand().UsePluginDir(pluginPath).
|
|
SetArgs("plugin", "install", "github.com/hashicorp/hashicups", "1.0.2-dev").
|
|
Assert(lib.MustFail(),
|
|
lib.Grep("Unsupported prerelease for constraint", lib.GrepStdout))
|
|
})
|
|
}
|