pulumi/cmd/pulumi-test-language/l2resourceasset_test.go

319 lines
11 KiB
Go
Raw Permalink Normal View History

Add asset/archive to conformance tests and fix engine working dir issues (#16100) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/16092. Two main changes in this PR. Firstly we add a test for assets/archives to the conformance tests, and had to fix up some small issues in the test runner to enable this (copying test data files, correcting project directory layout, handling multi-word package names). The other change is to fix the engine to respect the programs working directory when serialising/deserialising assets and archives. It does this by passing the programs working directory as a MarshalOption (n.b this option is only really needed in the engine, program SDK doesn't really need it because it doesn't change directories). ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-02 11:32:54 +00:00
// Copyright 2016-2024, 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 (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"testing"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/rpcutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/workspace"
pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
testingrpc "github.com/pulumi/pulumi/sdk/v3/proto/go/testing"
"github.com/segmentio/encoding/json"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/protobuf/types/known/structpb"
"gopkg.in/yaml.v2"
)
type L2ResourceAssetArchiveLanguageHost struct {
pulumirpc.UnimplementedLanguageRuntimeServer
tempDir string
}
func (h *L2ResourceAssetArchiveLanguageHost) Pack(
ctx context.Context, req *pulumirpc.PackRequest,
) (*pulumirpc.PackResponse, error) {
if req.DestinationDirectory != filepath.Join(h.tempDir, "artifacts") {
return nil, fmt.Errorf("unexpected destination directory %s", req.DestinationDirectory)
}
if req.PackageDirectory == filepath.Join(h.tempDir, "sdks", "asset-archive-5.0.0") {
return &pulumirpc.PackResponse{
ArtifactPath: filepath.Join(req.DestinationDirectory, "asset-archive-5.0.0.sdk"),
}, nil
} else if req.PackageDirectory != filepath.Join(h.tempDir, "sdks", "core") {
return &pulumirpc.PackResponse{
ArtifactPath: filepath.Join(req.DestinationDirectory, "core.sdk"),
}, nil
}
return nil, fmt.Errorf("unexpected package directory %s", req.PackageDirectory)
}
func (h *L2ResourceAssetArchiveLanguageHost) GenerateProject(
ctx context.Context, req *pulumirpc.GenerateProjectRequest,
) (*pulumirpc.GenerateProjectResponse, error) {
if req.LocalDependencies["pulumi"] != filepath.Join(h.tempDir, "artifacts", "core.sdk") {
return nil, fmt.Errorf("unexpected core sdk %s", req.LocalDependencies["pulumi"])
}
if req.LocalDependencies["asset-archive"] != filepath.Join(h.tempDir, "artifacts", "asset-archive-5.0.0.sdk") {
return nil, fmt.Errorf("unexpected asset-archive sdk %s", req.LocalDependencies["asset-archive"])
}
if !req.Strict {
return nil, errors.New("expected strict to be true")
}
if req.TargetDirectory != filepath.Join(h.tempDir, "projects", "l2-resource-asset-archive") {
return nil, fmt.Errorf("unexpected target directory %s", req.TargetDirectory)
}
var project workspace.Project
if err := json.Unmarshal([]byte(req.Project), &project); err != nil {
return nil, err
}
if project.Name != "l2-resource-asset-archive" {
return nil, fmt.Errorf("unexpected project name %s", project.Name)
}
if project.Main != "subdir" {
return nil, fmt.Errorf("unexpected project main %s", project.Main)
}
project.Runtime = workspace.NewProjectRuntimeInfo("mock", nil)
projectYaml, err := yaml.Marshal(project)
if err != nil {
return nil, fmt.Errorf("marshal project: %w", err)
}
// Write the minimal project file.
if err := os.WriteFile(filepath.Join(req.TargetDirectory, "Pulumi.yaml"), projectYaml, 0o600); err != nil {
return nil, fmt.Errorf("write project file: %w", err)
}
// And the main subdir, although nothing is in it
if err := os.MkdirAll(filepath.Join(req.TargetDirectory, "subdir"), 0o700); err != nil {
return nil, fmt.Errorf("make main directory: %w", err)
}
return &pulumirpc.GenerateProjectResponse{}, nil
}
func (h *L2ResourceAssetArchiveLanguageHost) GeneratePackage(
ctx context.Context, req *pulumirpc.GeneratePackageRequest,
) (*pulumirpc.GeneratePackageResponse, error) {
if req.LocalDependencies["pulumi"] != filepath.Join(h.tempDir, "artifacts", "core.sdk") {
return nil, fmt.Errorf("unexpected core sdk %s", req.LocalDependencies["pulumi"])
}
if req.Directory != filepath.Join(h.tempDir, "sdks", "asset-archive-5.0.0") {
return nil, fmt.Errorf("unexpected directory %s", req.Directory)
}
// Write the minimal package code.
if err := os.WriteFile(filepath.Join(req.Directory, "test.txt"), []byte("testing"), 0o600); err != nil {
return nil, err
}
return &pulumirpc.GeneratePackageResponse{}, nil
}
func (h *L2ResourceAssetArchiveLanguageHost) GetRequiredPlugins(
ctx context.Context, req *pulumirpc.GetRequiredPluginsRequest,
) (*pulumirpc.GetRequiredPluginsResponse, error) {
if req.Info.ProgramDirectory != filepath.Join(h.tempDir, "projects", "l2-resource-asset-archive", "subdir") {
return nil, fmt.Errorf("unexpected directory to get required plugins %s", req.Info.ProgramDirectory)
}
return &pulumirpc.GetRequiredPluginsResponse{
Plugins: []*pulumirpc.PluginDependency{
{
Name: "asset-archive",
Kind: string(apitype.ResourcePlugin),
Version: "5.0.0",
},
},
}, nil
}
func (h *L2ResourceAssetArchiveLanguageHost) GetProgramDependencies(
ctx context.Context, req *pulumirpc.GetProgramDependenciesRequest,
) (*pulumirpc.GetProgramDependenciesResponse, error) {
if req.Info.ProgramDirectory != filepath.Join(h.tempDir, "projects", "l2-resource-asset-archive", "subdir") {
return nil, fmt.Errorf("unexpected directory to get program dependencies %s", req.Info.ProgramDirectory)
}
return &pulumirpc.GetProgramDependenciesResponse{
Dependencies: []*pulumirpc.DependencyInfo{
{
Name: "pulumi_pulumi",
Version: "1.0.1",
},
{
Name: "pulumi_asset_archive",
Version: "5.0.0",
},
},
}, nil
}
func (h *L2ResourceAssetArchiveLanguageHost) InstallDependencies(
req *pulumirpc.InstallDependenciesRequest, server pulumirpc.LanguageRuntime_InstallDependenciesServer,
) error {
if req.Info.RootDirectory != filepath.Join(h.tempDir, "projects", "l2-resource-asset-archive") {
return fmt.Errorf("unexpected root directory to install dependencies %s", req.Info.RootDirectory)
}
if req.Info.ProgramDirectory != filepath.Join(req.Info.RootDirectory, "subdir") {
return fmt.Errorf("unexpected program directory to install dependencies %s", req.Info.ProgramDirectory)
}
if req.Info.EntryPoint != "." {
return fmt.Errorf("unexpected entry point to install dependencies %s", req.Info.EntryPoint)
}
return nil
}
func (h *L2ResourceAssetArchiveLanguageHost) Run(
ctx context.Context, req *pulumirpc.RunRequest,
) (*pulumirpc.RunResponse, error) {
if req.Info.RootDirectory != filepath.Join(h.tempDir, "projects", "l2-resource-asset-archive") {
return nil, fmt.Errorf("unexpected root directory to run %s", req.Info.RootDirectory)
}
if req.Info.ProgramDirectory != filepath.Join(req.Info.RootDirectory, "subdir") {
return nil, fmt.Errorf("unexpected program directory to run %s", req.Info.ProgramDirectory)
}
if req.Info.EntryPoint != "." {
return nil, fmt.Errorf("unexpected entry point to run %s", req.Info.EntryPoint)
}
conn, err := grpc.Dial(
req.MonitorAddress,
grpc.WithTransportCredentials(insecure.NewCredentials()),
rpcutil.GrpcChannelOptions(),
)
if err != nil {
return nil, fmt.Errorf("could not connect to resource monitor: %w", err)
}
defer conn.Close()
monitor := pulumirpc.NewResourceMonitorClient(conn)
_, err = monitor.RegisterResource(ctx, &pulumirpc.RegisterResourceRequest{
Type: string(resource.RootStackType),
Name: req.Stack,
})
if err != nil {
return nil, fmt.Errorf("could not register stack: %w", err)
}
// Don't calculate hashes in the program, leave it to the engine
asset, err := plugin.MarshalAsset(&resource.Asset{
Path: "../test.txt",
}, plugin.MarshalOptions{})
if err != nil {
return nil, fmt.Errorf("could not marshal asset: %w", err)
}
_, err = monitor.RegisterResource(ctx, &pulumirpc.RegisterResourceRequest{
Type: "asset-archive:index:AssetResource",
Custom: true,
Name: "ass",
Object: &structpb.Struct{
Fields: map[string]*structpb.Value{
"value": asset,
},
},
})
if err != nil {
return nil, fmt.Errorf("could not register resource: %w", err)
}
archive, err := plugin.MarshalArchive(&resource.Archive{
Path: "../archive.tar",
}, plugin.MarshalOptions{})
if err != nil {
Fix folder archives in the engine (#16119) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/16092. Last part of the fix started in https://github.com/pulumi/pulumi/pull/16100. That last PR fixed assets and archive files, but not archive folders. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-06 07:26:48 +00:00
return nil, fmt.Errorf("could not marshal archive: %w", err)
Add asset/archive to conformance tests and fix engine working dir issues (#16100) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/16092. Two main changes in this PR. Firstly we add a test for assets/archives to the conformance tests, and had to fix up some small issues in the test runner to enable this (copying test data files, correcting project directory layout, handling multi-word package names). The other change is to fix the engine to respect the programs working directory when serialising/deserialising assets and archives. It does this by passing the programs working directory as a MarshalOption (n.b this option is only really needed in the engine, program SDK doesn't really need it because it doesn't change directories). ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-02 11:32:54 +00:00
}
_, err = monitor.RegisterResource(ctx, &pulumirpc.RegisterResourceRequest{
Type: "asset-archive:index:ArchiveResource",
Custom: true,
Name: "arc",
Object: &structpb.Struct{
Fields: map[string]*structpb.Value{
"value": archive,
},
},
})
if err != nil {
return nil, fmt.Errorf("could not register resource: %w", err)
}
Fix folder archives in the engine (#16119) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/16092. Last part of the fix started in https://github.com/pulumi/pulumi/pull/16100. That last PR fixed assets and archive files, but not archive folders. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-06 07:26:48 +00:00
folder, err := plugin.MarshalArchive(&resource.Archive{
Path: "../folder",
}, plugin.MarshalOptions{})
if err != nil {
return nil, fmt.Errorf("could not marshal folder: %w", err)
}
_, err = monitor.RegisterResource(ctx, &pulumirpc.RegisterResourceRequest{
Type: "asset-archive:index:ArchiveResource",
Custom: true,
Name: "dir",
Object: &structpb.Struct{
Fields: map[string]*structpb.Value{
"value": folder,
},
},
})
if err != nil {
return nil, fmt.Errorf("could not register resource: %w", err)
}
Add asset/archive to conformance tests and fix engine working dir issues (#16100) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/16092. Two main changes in this PR. Firstly we add a test for assets/archives to the conformance tests, and had to fix up some small issues in the test runner to enable this (copying test data files, correcting project directory layout, handling multi-word package names). The other change is to fix the engine to respect the programs working directory when serialising/deserialising assets and archives. It does this by passing the programs working directory as a MarshalOption (n.b this option is only really needed in the engine, program SDK doesn't really need it because it doesn't change directories). ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2024-05-02 11:32:54 +00:00
return &pulumirpc.RunResponse{}, nil
}
// Run a simple successful test with a mocked runtime.
func TestL2ResourceAssetArchive(t *testing.T) {
t.Parallel()
ctx := context.Background()
tempDir := t.TempDir()
engine := &languageTestServer{}
runtime := &L2ResourceAssetArchiveLanguageHost{tempDir: tempDir}
handle, err := rpcutil.ServeWithOptions(rpcutil.ServeOptions{
Init: func(srv *grpc.Server) error {
pulumirpc.RegisterLanguageRuntimeServer(srv, runtime)
return nil
},
})
require.NoError(t, err)
prepareResponse, err := engine.PrepareLanguageTests(ctx, &testingrpc.PrepareLanguageTestsRequest{
LanguagePluginName: "mock",
LanguagePluginTarget: fmt.Sprintf("127.0.0.1:%d", handle.Port),
TemporaryDirectory: tempDir,
SnapshotDirectory: "./testdata/snapshots",
CoreSdkDirectory: "sdk/dir",
CoreSdkVersion: "1.0.1",
})
require.NoError(t, err)
assert.NotEmpty(t, prepareResponse.Token)
runResponse, err := engine.RunLanguageTest(ctx, &testingrpc.RunLanguageTestRequest{
Token: prepareResponse.Token,
Test: "l2-resource-asset-archive",
})
require.NoError(t, err)
t.Logf("stdout: %s", runResponse.Stdout)
t.Logf("stderr: %s", runResponse.Stderr)
assert.Empty(t, runResponse.Messages)
assert.True(t, runResponse.Success)
}