2021-07-06 22:40:53 +00:00
|
|
|
// *** WARNING: this file was generated by test. ***
|
|
|
|
// *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
|
|
|
|
|
|
|
Support returning plain values from methods (#13592)
Support returning plain values from methods.
Implements Node, Python and Go support.
Remaining:
- [x] test receiving unknowns
- [x] acceptance tests written and passing locally for Node, Python, Go
clients against a Go server
- [x] acceptance tests passing in CI
- [x] tickets filed for remaining languages
- [x] https://github.com/pulumi/pulumi-yaml/issues/499
- [x] https://github.com/pulumi/pulumi-java/issues/1193
- [x] https://github.com/pulumi/pulumi-dotnet/issues/170
Known limitations:
- this is technically a breaking change in case there is code out there
that already uses methods that return Plain: true
- struct-wrapping limitation: the provider for the component resource
needs to still wrap the plain-returning Method response with a 1-arg
struct; by convention the field is named "res", and this is how it
travels through the plumbing
- resources cannot return plain values yet
- the provider for the component resource cannot have unknown
configuration, if it does, the methods will not be called
- Per Luke https://github.com/pulumi/pulumi/issues/11520 this might not
be supported/realizable yet
<!---
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/12709
## Checklist
- [ ] I have run `make tidy` to update any new dependencies
- [ ] I have run `make lint` to verify my code passes the lint check
- [ ] I have formatted my code using `gofumpt`
<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my
feature works
<!---
User-facing changes require a CHANGELOG entry.
-->
- [ ] 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. -->
2023-11-18 06:02:06 +00:00
|
|
|
import * as runtime from "@pulumi/pulumi/runtime";
|
|
|
|
import * as pulumi from "@pulumi/pulumi";
|
|
|
|
|
2021-07-06 22:40:53 +00:00
|
|
|
export function getEnv(...vars: string[]): string | undefined {
|
|
|
|
for (const v of vars) {
|
|
|
|
const value = process.env[v];
|
|
|
|
if (value) {
|
|
|
|
return value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
|
|
|
|
export function getEnvBoolean(...vars: string[]): boolean | undefined {
|
|
|
|
const s = getEnv(...vars);
|
|
|
|
if (s !== undefined) {
|
|
|
|
// NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what
|
|
|
|
// Terraform uses internally when parsing boolean values.
|
|
|
|
if (["1", "t", "T", "true", "TRUE", "True"].find(v => v === s) !== undefined) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
if (["0", "f", "F", "false", "FALSE", "False"].find(v => v === s) !== undefined) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
|
|
|
|
export function getEnvNumber(...vars: string[]): number | undefined {
|
|
|
|
const s = getEnv(...vars);
|
|
|
|
if (s !== undefined) {
|
|
|
|
const f = parseFloat(s);
|
|
|
|
if (!isNaN(f)) {
|
|
|
|
return f;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
|
|
|
|
export function getVersion(): string {
|
|
|
|
let version = require('./package.json').version;
|
|
|
|
// Node allows for the version to be prefixed by a "v", while semver doesn't.
|
|
|
|
// If there is a v, strip it off.
|
|
|
|
if (version.indexOf('v') === 0) {
|
|
|
|
version = version.slice(1);
|
|
|
|
}
|
|
|
|
return version;
|
|
|
|
}
|
2022-01-10 23:54:41 +00:00
|
|
|
|
|
|
|
/** @internal */
|
|
|
|
export function resourceOptsDefaults(): any {
|
2022-01-11 01:38:54 +00:00
|
|
|
return { version: getVersion(), pluginDownloadURL: "example.com/download" };
|
2022-01-10 23:54:41 +00:00
|
|
|
}
|
2022-09-01 22:42:44 +00:00
|
|
|
|
|
|
|
/** @internal */
|
|
|
|
export function lazyLoad(exports: any, props: string[], loadModule: any) {
|
|
|
|
for (let property of props) {
|
|
|
|
Object.defineProperty(exports, property, {
|
|
|
|
enumerable: true,
|
|
|
|
get: function() {
|
|
|
|
return loadModule()[property];
|
|
|
|
},
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
Support returning plain values from methods (#13592)
Support returning plain values from methods.
Implements Node, Python and Go support.
Remaining:
- [x] test receiving unknowns
- [x] acceptance tests written and passing locally for Node, Python, Go
clients against a Go server
- [x] acceptance tests passing in CI
- [x] tickets filed for remaining languages
- [x] https://github.com/pulumi/pulumi-yaml/issues/499
- [x] https://github.com/pulumi/pulumi-java/issues/1193
- [x] https://github.com/pulumi/pulumi-dotnet/issues/170
Known limitations:
- this is technically a breaking change in case there is code out there
that already uses methods that return Plain: true
- struct-wrapping limitation: the provider for the component resource
needs to still wrap the plain-returning Method response with a 1-arg
struct; by convention the field is named "res", and this is how it
travels through the plumbing
- resources cannot return plain values yet
- the provider for the component resource cannot have unknown
configuration, if it does, the methods will not be called
- Per Luke https://github.com/pulumi/pulumi/issues/11520 this might not
be supported/realizable yet
<!---
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/12709
## Checklist
- [ ] I have run `make tidy` to update any new dependencies
- [ ] I have run `make lint` to verify my code passes the lint check
- [ ] I have formatted my code using `gofumpt`
<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my
feature works
<!---
User-facing changes require a CHANGELOG entry.
-->
- [ ] 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. -->
2023-11-18 06:02:06 +00:00
|
|
|
|
|
|
|
export async function callAsync<T>(
|
|
|
|
tok: string,
|
|
|
|
props: pulumi.Inputs,
|
|
|
|
res?: pulumi.Resource,
|
|
|
|
opts?: {property?: string},
|
|
|
|
): Promise<T> {
|
|
|
|
const o: any = runtime.call<T>(tok, props, res);
|
|
|
|
const value = await o.promise(true /*withUnknowns*/);
|
|
|
|
const isKnown = await o.isKnown;
|
|
|
|
const isSecret = await o.isSecret;
|
|
|
|
const problem: string|undefined =
|
|
|
|
!isKnown ? "an unknown value"
|
|
|
|
: isSecret ? "a secret value"
|
|
|
|
: undefined;
|
|
|
|
// Ingoring o.resources silently. They are typically non-empty, r.f() calls include r as a dependency.
|
|
|
|
if (problem) {
|
|
|
|
throw new Error(`Plain resource method "${tok}" incorrectly returned ${problem}. ` +
|
|
|
|
"This is an error in the provider, please report this to the provider developer.");
|
|
|
|
}
|
|
|
|
// Extract a single property if requested.
|
|
|
|
if (opts && opts.property) {
|
|
|
|
return value[opts.property];
|
|
|
|
}
|
|
|
|
return value;
|
|
|
|
}
|