2024-06-12 15:38:21 -04:00
|
|
|
package plugin_tests
|
2024-05-03 15:41:36 -04:00
|
|
|
|
2024-08-15 10:05:27 -04:00
|
|
|
import "github.com/hashicorp/packer/packer_test/common/check"
|
2024-06-12 15:38:21 -04:00
|
|
|
|
|
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginWithMetadata() {
|
2024-08-15 14:09:33 -04:00
|
|
|
tempPluginDir := ts.MakePluginDir()
|
|
|
|
|
defer tempPluginDir.Cleanup()
|
2024-05-03 15:41:36 -04:00
|
|
|
|
2024-05-16 10:27:19 -04:00
|
|
|
ts.Run("install plugin with metadata in version", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
packer_test: split BuildPackerPlugin in build/get
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.
2024-08-14 16:12:53 -04:00
|
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0+metadata"), "github.com/hashicorp/tester").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("Successfully installed plugin", check.GrepStdout))
|
2024-05-16 10:27:19 -04:00
|
|
|
})
|
|
|
|
|
|
2024-05-03 15:41:36 -04:00
|
|
|
ts.Run("metadata plugin installed must not have metadata in its path", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
|
|
|
SetArgs("plugins", "installed").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("packer-plugin-tester_v1.0.0[^+]", check.GrepStdout))
|
2024-05-03 15:41:36 -04:00
|
|
|
})
|
|
|
|
|
|
|
|
|
|
ts.Run("plugin with metadata should work with validate", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
|
|
|
SetArgs("validate", "./templates/simple.pkr.hcl").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("packer-plugin-tester_v1.0.0[^+][^\\n]+plugin:", check.GrepStderr))
|
2024-05-03 15:41:36 -04:00
|
|
|
})
|
|
|
|
|
|
|
|
|
|
ts.Run("plugin with metadata should work with build", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
|
|
|
SetArgs("build", "./templates/simple.pkr.hcl").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("packer-plugin-tester_v1.0.0[^+][^\\n]+plugin:", check.GrepStderr))
|
2024-05-03 15:41:36 -04:00
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2024-06-12 15:38:21 -04:00
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginWithPath() {
|
2024-08-15 14:09:33 -04:00
|
|
|
tempPluginDir := ts.MakePluginDir()
|
|
|
|
|
defer tempPluginDir.Cleanup()
|
2024-05-16 10:29:16 -04:00
|
|
|
|
|
|
|
|
ts.Run("install plugin with pre-release only", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
packer_test: split BuildPackerPlugin in build/get
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.
2024-08-14 16:12:53 -04:00
|
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0-dev"), "github.com/hashicorp/tester").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("Successfully installed plugin", check.GrepStdout))
|
2024-05-16 10:29:16 -04:00
|
|
|
})
|
|
|
|
|
|
|
|
|
|
ts.Run("install same plugin with pre-release + metadata", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
packer_test: split BuildPackerPlugin in build/get
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.
2024-08-14 16:12:53 -04:00
|
|
|
SetArgs("plugins", "install", "--path", ts.GetPluginPath(ts.T(), "1.0.0-dev+metadata"), "github.com/hashicorp/tester").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(), check.Grep("Successfully installed plugin", check.GrepStdout))
|
2024-05-16 10:29:16 -04:00
|
|
|
})
|
|
|
|
|
|
|
|
|
|
ts.Run("list plugins, should only report one plugin", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(tempPluginDir).
|
|
|
|
|
SetArgs("plugins", "installed").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed(),
|
|
|
|
|
check.Grep("plugin-tester_v1.0.0-dev[^+]", check.GrepStdout),
|
|
|
|
|
check.GrepInverted("plugin-tester_v1.0.0-dev\\+", check.GrepStdout),
|
|
|
|
|
check.LineCountCheck(1))
|
2024-05-16 10:29:16 -04:00
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2024-06-12 15:38:21 -04:00
|
|
|
func (ts *PackerPluginTestSuite) TestInstallPluginPrerelease() {
|
packer_test: split BuildPackerPlugin in build/get
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.
2024-08-14 16:12:53 -04:00
|
|
|
pluginPath := ts.GetPluginPath(ts.T(), "1.0.1-alpha1")
|
2024-05-03 15:41:36 -04:00
|
|
|
|
2024-08-15 14:09:33 -04:00
|
|
|
pluginDir := ts.MakePluginDir()
|
|
|
|
|
defer pluginDir.Cleanup()
|
2024-05-03 15:41:36 -04:00
|
|
|
|
|
|
|
|
ts.Run("try install plugin with alpha1 prerelease - should fail", func() {
|
|
|
|
|
ts.PackerCommand().UsePluginDir(pluginDir).
|
|
|
|
|
SetArgs("plugins", "install", "--path", pluginPath, "github.com/hashicorp/tester").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustFail(), check.Grep("Packer can only install plugin releases with this command", check.GrepStdout))
|
2024-05-03 15:41:36 -04:00
|
|
|
})
|
|
|
|
|
}
|
2024-05-07 16:26:20 -04:00
|
|
|
|
2024-06-12 15:38:21 -04:00
|
|
|
func (ts *PackerPluginTestSuite) TestRemoteInstallWithPluginsInstall() {
|
2024-06-12 15:54:03 -04:00
|
|
|
ts.SkipNoAcc()
|
|
|
|
|
|
2024-08-15 14:09:33 -04:00
|
|
|
pluginPath := ts.MakePluginDir()
|
|
|
|
|
defer pluginPath.Cleanup()
|
2024-05-07 16:26:20 -04:00
|
|
|
|
|
|
|
|
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").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustSucceed())
|
2024-05-07 16:26:20 -04:00
|
|
|
})
|
2024-05-29 14:59:45 -04:00
|
|
|
}
|
|
|
|
|
|
2024-06-12 15:38:21 -04:00
|
|
|
func (ts *PackerPluginTestSuite) TestRemoteInstallOfPreReleasePlugin() {
|
2024-06-12 15:54:03 -04:00
|
|
|
ts.SkipNoAcc()
|
|
|
|
|
|
2024-08-15 14:09:33 -04:00
|
|
|
pluginPath := ts.MakePluginDir()
|
|
|
|
|
defer pluginPath.Cleanup()
|
2024-05-29 14:59:45 -04:00
|
|
|
|
|
|
|
|
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").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustFail(),
|
|
|
|
|
check.Grep("Invalid version constraint", check.GrepStdout),
|
|
|
|
|
check.Grep("Unsupported prerelease for constraint", check.GrepStdout))
|
2024-05-29 14:59:45 -04:00
|
|
|
})
|
2024-05-07 16:26:20 -04:00
|
|
|
|
2024-05-29 14:59:45 -04:00
|
|
|
ts.Run("try to plugins install with a pre-release version - should fail", func() {
|
2024-05-07 16:26:20 -04:00
|
|
|
ts.PackerCommand().UsePluginDir(pluginPath).
|
2024-05-29 14:59:45 -04:00
|
|
|
SetArgs("plugin", "install", "github.com/hashicorp/hashicups", "1.0.2-dev").
|
2024-08-15 10:05:27 -04:00
|
|
|
Assert(check.MustFail(),
|
|
|
|
|
check.Grep("Unsupported prerelease for constraint", check.GrepStdout))
|
2024-05-15 14:16:31 -04:00
|
|
|
})
|
|
|
|
|
}
|