28579eba94
Note: for the purposes of this discussion, archives will be treated as assets, as their differences are not particularly meaningful. Currently, the identity of an asset is derived from the hash and the location of its contents (i.e. two assets are equal iff their contents have the same hash and the same path/URI/inline value). This means that changing the source of an asset will cause the engine to detect a difference in the asset even if the source's contents are identical. At best, this leads to inefficiencies such as unnecessary updates. This commit changes asset identity so that it is derived solely from an asset's hash. The source of an asset's contents is no longer part of the asset's identity, and need only be provided if the contents themselves may need to be available (e.g. if a hash does not yet exist for the asset or if the asset's contents might be needed for an update). This commit also changes the way old assets are exposed to providers. Currently, an old asset is exposed as both its hash and its contents. This allows providers to take a dependency on the contents of an old asset being available, even though this is not an invariant of the system. These changes remove the contents of old assets from their serialized form when they are passed to providers, eliminating the ability of a provider to take such a dependency. In combination with the changes to asset identity, this allows a provider to detect changes to an asset simply by comparing its old and new hashes. This is half of the fix for [pulumi/pulumi-cloud#158]. The other half involves changes in [pulumi/pulumi-terraform].
346 lines
12 KiB
Go
346 lines
12 KiB
Go
// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
|
|
|
|
package resource
|
|
|
|
import (
|
|
"archive/tar"
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"math/rand"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/pulumi/pulumi/pkg/util/contract"
|
|
)
|
|
|
|
func TestAssetSerialize(t *testing.T) {
|
|
// Ensure that asset and archive serialization round trips.
|
|
{
|
|
text := "a test asset"
|
|
asset, err := NewTextAsset(text)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, text, asset.Text)
|
|
assert.Equal(t, "e34c74529110661faae4e121e57165ff4cb4dbdde1ef9770098aa3695e6b6704", asset.Hash)
|
|
assetSer := asset.Serialize()
|
|
assetDes, isasset, err := DeserializeAsset(assetSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isasset)
|
|
assert.True(t, assetDes.IsText())
|
|
assert.Equal(t, text, assetDes.Text)
|
|
assert.Equal(t, "e34c74529110661faae4e121e57165ff4cb4dbdde1ef9770098aa3695e6b6704", assetDes.Hash)
|
|
|
|
// another text asset with the same contents, should hash the same way.
|
|
text2 := "a test asset"
|
|
asset2, err := NewTextAsset(text2)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, text2, asset2.Text)
|
|
assert.Equal(t, "e34c74529110661faae4e121e57165ff4cb4dbdde1ef9770098aa3695e6b6704", asset2.Hash)
|
|
|
|
// another text asset, but with different contents, should be a different hash.
|
|
text3 := "a very different and special test asset"
|
|
asset3, err := NewTextAsset(text3)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, text3, asset3.Text)
|
|
assert.Equal(t, "9a6ed070e1ff834427105844ffd8a399a634753ce7a60ec5aae541524bbe7036", asset3.Hash)
|
|
|
|
arch, err := NewAssetArchive(map[string]interface{}{"foo": asset})
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "d8ce0142b3b10300c7c76487fad770f794c1e84e1b0c73a4b2e1503d4fbac093", arch.Hash)
|
|
archSer := arch.Serialize()
|
|
archDes, isarch, err := DeserializeArchive(archSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isarch)
|
|
assert.True(t, archDes.IsAssets())
|
|
assert.Equal(t, 1, len(archDes.Assets))
|
|
assert.True(t, archDes.Assets["foo"].(*Asset).IsText())
|
|
assert.Equal(t, text, archDes.Assets["foo"].(*Asset).Text)
|
|
assert.Equal(t, "d8ce0142b3b10300c7c76487fad770f794c1e84e1b0c73a4b2e1503d4fbac093", archDes.Hash)
|
|
}
|
|
{
|
|
file := "/dev/null"
|
|
asset, err := NewPathAsset(file)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", asset.Hash)
|
|
assetSer := asset.Serialize()
|
|
assetDes, isasset, err := DeserializeAsset(assetSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isasset)
|
|
assert.True(t, assetDes.IsPath())
|
|
assert.Equal(t, file, assetDes.Path)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", assetDes.Hash)
|
|
|
|
arch, err := NewAssetArchive(map[string]interface{}{"foo": asset})
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "23f6c195eb154be262216cd97209f2dcc8a40038ac8ec18ca6218d3e3dfacd4e", arch.Hash)
|
|
archSer := arch.Serialize()
|
|
archDes, isarch, err := DeserializeArchive(archSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isarch)
|
|
assert.True(t, archDes.IsAssets())
|
|
assert.Equal(t, 1, len(archDes.Assets))
|
|
assert.True(t, archDes.Assets["foo"].(*Asset).IsPath())
|
|
assert.Equal(t, file, archDes.Assets["foo"].(*Asset).Path)
|
|
assert.Equal(t, "23f6c195eb154be262216cd97209f2dcc8a40038ac8ec18ca6218d3e3dfacd4e", archDes.Hash)
|
|
}
|
|
{
|
|
url := "file:///dev/null"
|
|
asset, err := NewURIAsset(url)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", asset.Hash)
|
|
assetSer := asset.Serialize()
|
|
assetDes, isasset, err := DeserializeAsset(assetSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isasset)
|
|
assert.True(t, assetDes.IsURI())
|
|
assert.Equal(t, url, assetDes.URI)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", assetDes.Hash)
|
|
|
|
arch, err := NewAssetArchive(map[string]interface{}{"foo": asset})
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "23f6c195eb154be262216cd97209f2dcc8a40038ac8ec18ca6218d3e3dfacd4e", arch.Hash)
|
|
archSer := arch.Serialize()
|
|
archDes, isarch, err := DeserializeArchive(archSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isarch)
|
|
assert.True(t, archDes.IsAssets())
|
|
assert.Equal(t, 1, len(archDes.Assets))
|
|
assert.True(t, archDes.Assets["foo"].(*Asset).IsURI())
|
|
assert.Equal(t, url, archDes.Assets["foo"].(*Asset).URI)
|
|
assert.Equal(t, "23f6c195eb154be262216cd97209f2dcc8a40038ac8ec18ca6218d3e3dfacd4e", archDes.Hash)
|
|
}
|
|
{
|
|
file, err := tempArchive("test", false)
|
|
assert.Nil(t, err)
|
|
defer func() { contract.IgnoreError(os.Remove(file)) }()
|
|
arch, err := NewPathArchive(file)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", arch.Hash)
|
|
archSer := arch.Serialize()
|
|
archDes, isarch, err := DeserializeArchive(archSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isarch)
|
|
assert.True(t, archDes.IsPath())
|
|
assert.Equal(t, file, archDes.Path)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", archDes.Hash)
|
|
}
|
|
{
|
|
file, err := tempArchive("test", false)
|
|
assert.Nil(t, err)
|
|
defer func() { contract.IgnoreError(os.Remove(file)) }()
|
|
url := "file:///" + file
|
|
arch, err := NewURIArchive(url)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", arch.Hash)
|
|
archSer := arch.Serialize()
|
|
archDes, isarch, err := DeserializeArchive(archSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isarch)
|
|
assert.True(t, archDes.IsURI())
|
|
assert.Equal(t, url, archDes.URI)
|
|
assert.Equal(t, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", archDes.Hash)
|
|
}
|
|
{
|
|
file1, err := tempArchive("test", false)
|
|
assert.Nil(t, err)
|
|
defer func() { contract.IgnoreError(os.Remove(file1)) }()
|
|
file2, err := tempArchive("test2", false)
|
|
assert.Nil(t, err)
|
|
defer func() { contract.IgnoreError(os.Remove(file2)) }()
|
|
arch1, err := NewPathArchive(file1)
|
|
assert.Nil(t, err)
|
|
arch2, err := NewPathArchive(file2)
|
|
assert.Nil(t, err)
|
|
assert.True(t, arch1.Equals(arch2))
|
|
url := "file:///" + file1
|
|
arch3, err := NewURIArchive(url)
|
|
assert.Nil(t, err)
|
|
assert.True(t, arch1.Equals(arch3))
|
|
}
|
|
{
|
|
file, err := tempArchive("test", true)
|
|
assert.Nil(t, err)
|
|
arch1, err := NewPathArchive(file)
|
|
assert.Nil(t, err)
|
|
assert.Nil(t, arch1.EnsureHash())
|
|
url := "file:///" + file
|
|
arch2, err := NewURIArchive(url)
|
|
assert.Nil(t, err)
|
|
assert.Nil(t, arch2.EnsureHash())
|
|
|
|
assert.Nil(t, os.Truncate(file, 0))
|
|
arch3, err := NewPathArchive(file)
|
|
assert.Nil(t, err)
|
|
assert.Nil(t, arch3.EnsureHash())
|
|
assert.False(t, arch1.Equals(arch3))
|
|
arch4, err := NewURIArchive(url)
|
|
assert.Nil(t, err)
|
|
assert.Nil(t, arch4.EnsureHash())
|
|
assert.False(t, arch2.Equals(arch4))
|
|
}
|
|
}
|
|
|
|
func tempArchive(prefix string, fill bool) (string, error) {
|
|
for {
|
|
path := filepath.Join(os.TempDir(), fmt.Sprintf("%s-%x.tar", prefix, rand.Uint32()))
|
|
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_EXCL, 0600)
|
|
switch {
|
|
case os.IsExist(err):
|
|
continue
|
|
case err != nil:
|
|
return "", err
|
|
default:
|
|
defer contract.IgnoreClose(f)
|
|
|
|
// write out a tar file. if `fill` is true, add a single empty file.
|
|
if fill {
|
|
w := tar.NewWriter(f)
|
|
defer contract.IgnoreClose(w)
|
|
|
|
err = w.WriteHeader(&tar.Header{
|
|
Name: "file",
|
|
Mode: 0600,
|
|
Size: 0,
|
|
})
|
|
}
|
|
return path, err
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDeserializeMissingHash(t *testing.T) {
|
|
assetSer := (&Asset{Text: "asset"}).Serialize()
|
|
assetDes, isasset, err := DeserializeAsset(assetSer)
|
|
assert.Nil(t, err)
|
|
assert.True(t, isasset)
|
|
assert.Equal(t, "asset", assetDes.Text)
|
|
}
|
|
|
|
func TestAssetFile(t *testing.T) {
|
|
asset, err := NewPathAsset("./testdata/Fox.txt")
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "85e5f2698ac92d10d50e2f2802ed0d51a13e7c81d0d0a5998a75349469e774c5", asset.Hash)
|
|
assertAssetTextEquals(t, asset,
|
|
`The quick brown 🦊 jumps over
|
|
the lazy 🐶. The quick brown
|
|
asset jumps over the archive.
|
|
|
|
`)
|
|
}
|
|
|
|
func TestArchiveDir(t *testing.T) {
|
|
arch, err := NewPathArchive("./testdata/test_dir")
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "35ddf9c48ce6ac5ba657573d388db6ce41f3ed6965346a3086fb70a550fe0864", arch.Hash)
|
|
validateTestDirArchive(t, arch)
|
|
}
|
|
|
|
func TestArchiveTar(t *testing.T) {
|
|
arch, err := NewPathArchive("./testdata/test_dir.tar")
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "c618d74a40f87de3092ca6a6c4cca834aa5c6a3956c6ceb2054b40d04bb4cd76", arch.Hash)
|
|
validateTestDirArchive(t, arch)
|
|
}
|
|
|
|
func TestArchiveTgz(t *testing.T) {
|
|
arch, err := NewPathArchive("./testdata/test_dir.tgz")
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "f9b33523b6a3538138aff0769ff9e7d522038e33c5cfe28b258332b3f15790c8", arch.Hash)
|
|
validateTestDirArchive(t, arch)
|
|
}
|
|
|
|
func TestArchiveZip(t *testing.T) {
|
|
arch, err := NewPathArchive("./testdata/test_dir.zip")
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, "343da72cec1302441efd4a490d66f861d393fb270afb3ced27f92a0d96abc068", arch.Hash)
|
|
validateTestDirArchive(t, arch)
|
|
}
|
|
|
|
func validateTestDirArchive(t *testing.T, arch *Archive) {
|
|
r, err := arch.Open()
|
|
assert.Nil(t, err)
|
|
defer func() {
|
|
assert.Nil(t, r.Close())
|
|
}()
|
|
|
|
subs := make(map[string]string)
|
|
for {
|
|
name, blob, err := r.Next()
|
|
if err == io.EOF {
|
|
break
|
|
}
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, blob)
|
|
|
|
// Check for duplicates
|
|
_, ok := subs[name]
|
|
assert.False(t, ok)
|
|
|
|
// Read the blob
|
|
var text bytes.Buffer
|
|
_, err = io.Copy(&text, blob)
|
|
assert.Nil(t, err)
|
|
err = blob.Close()
|
|
assert.Nil(t, err)
|
|
|
|
// Store its contents in subs
|
|
subs[name] = text.String()
|
|
}
|
|
|
|
assert.Equal(t, 3, len(subs))
|
|
|
|
lorem := subs["Lorem_ipsum.txt"]
|
|
assert.Equal(t, lorem,
|
|
`Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
|
|
aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis
|
|
aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
|
|
occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
|
|
|
`)
|
|
|
|
butimust := subs["sub_dir/But_I_must"]
|
|
assert.Equal(t, butimust,
|
|
`Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem
|
|
aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim
|
|
ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione
|
|
voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit amet consectetur adipisci[ng]
|
|
velit, sed quia non numquam [do] eius modi tempora inci[di]dunt, ut labore et dolore magnam aliquam quaerat voluptatem.
|
|
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi
|
|
consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur,
|
|
vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?
|
|
|
|
`)
|
|
|
|
ontheother := subs["sub_dir/On_the_other_hand.md"]
|
|
assert.Equal(t, ontheother,
|
|
`At vero eos et accusamus et iusto odio dignissimos ducimus, qui blanditiis praesentium voluptatum deleniti atque
|
|
corrupti, quos dolores et quas molestias excepturi sint, obcaecati cupiditate non provident, similique sunt in culpa,
|
|
qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita
|
|
distinctio. Nam libero tempore, cum soluta nobis est eligendi optio, cumque nihil impedit, quo minus id, quod maxime
|
|
placeat, facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut
|
|
officiis debitis aut rerum necessitatibus saepe eveniet, ut et voluptates repudiandae sint et molestiae non recusandae.
|
|
Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut
|
|
perferendis doloribus asperiores repellat…
|
|
|
|
`)
|
|
}
|
|
|
|
func assertAssetTextEquals(t *testing.T, asset *Asset, expect string) {
|
|
blob, err := asset.Read()
|
|
assert.Nil(t, err)
|
|
assert.NotNil(t, blob)
|
|
assertAssetBlobEquals(t, blob, expect)
|
|
}
|
|
|
|
func assertAssetBlobEquals(t *testing.T, blob *Blob, expect string) {
|
|
var text bytes.Buffer
|
|
_, err := io.Copy(&text, blob)
|
|
assert.Nil(t, err)
|
|
assert.Equal(t, expect, text.String())
|
|
err = blob.Close()
|
|
assert.Nil(t, err)
|
|
}
|