pulumi/sdk/nodejs/tests/resource.spec.ts
Luke Hoban 15e924b5cf
Support aliases for renaming, re-typing, or re-parenting resources (#2774)
Adds a new resource option `aliases` which can be used to rename a resource.  When making a breaking change to the name or type of a resource or component, the old name can be added to the list of `aliases` for a resource to ensure that existing resources will be migrated to the new name instead of being deleted and replaced with the new named resource.

There are two key places this change is implemented. 

The first is the step generator in the engine.  When computing whether there is an old version of a registered resource, we now take into account the aliases specified on the registered resource.  That is, we first look up the resource by its new URN in the old state, and then by any aliases provided (in order).  This can allow the resource to be matched as a (potential) update to an existing resource with a different URN.

The second is the core `Resource` constructor in the JavaScript (and soon Python) SDKs.  This change ensures that when a parent resource is aliased, that all children implicitly inherit corresponding aliases.  It is similar to how many other resource options are "inherited" implicitly from the parent.

Four specific scenarios are explicitly tested as part of this PR:
1. Renaming a resource
2. Adopting a resource into a component (as the owner of both component and consumption codebases)
3. Renaming a component instance (as the owner of the consumption codebase without changes to the component)
4. Changing the type of a component (as the owner of the component codebase without changes to the consumption codebase)
4. Combining (1) and (3) to make both changes to a resource at the same time
2019-05-31 23:01:01 -07:00

66 lines
2.4 KiB
TypeScript

// 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.
// tslint:disable
import * as assert from "assert";
import { Output, concat, interpolate, output } from "../output";
import * as runtime from "../runtime";
import { asyncTest } from "./util";
import { createUrn, ComponentResource, CustomResourceOptions } from "../resource";
class MyResource extends ComponentResource {
constructor(name: string, opts?: CustomResourceOptions) {
super("my:mod:MyResource", name, {}, opts);
}
}
class MyParentResource extends ComponentResource {
child: MyResource;
constructor(name: string, opts?: CustomResourceOptions) {
super("my:mod:MyParentResource", name, {}, opts);
this.child = new MyResource(`${name}-child`, { parent: this });
}
}
describe("createUrn", () => {
before(() => {
runtime._setTestModeEnabled(true);
runtime._setProject("myproject");
runtime._setStack("mystack");
});
after(() => {
runtime._setTestModeEnabled(false);
runtime._setProject(undefined);
runtime._setStack(undefined);
});
it("handles name and type", asyncTest(async () => {
const urn = await createUrn("n", "t").promise();
assert.equal(urn, "urn:pulumi:mystack::myproject::t::n");
}));
it("handles name and type and parent", asyncTest(async () => {
const res = new MyResource("myres");
const urn = await createUrn("n", "t", res).promise();
assert.equal(urn, "urn:pulumi:mystack::myproject::my:mod:MyResource$t::n");
}));
it("handles name and type and parent with parent", asyncTest(async () => {
const res = new MyParentResource("myres");
const urn = await createUrn("n", "t", res.child).promise();
assert.equal(urn, "urn:pulumi:mystack::myproject::my:mod:MyParentResource$my:mod:MyResource$t::n");
}));
});