pulumi/sdk/nodejs
bors[bot] 6f0ee42b7c
Merge #13033
13033: test(sdk/npm): Don't download from NPM or Yarn regstries r=Frassle a=abhinav

Follow up to #12983

Tests that download from NPM or Yarn will be brittle, unsafe, and slow.
We don't need to hit these servers directly.

This change alters the package installation tests to
set up a local HTTP server that implements a subset of the
[NPM Package Registry API][1] -- just enough to satisfy these tests.

  [1]: https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md

In the tests, we'll set `$HOME` to a new temporary directory and write
an `~/.npmrc` or `~/.yarnrc` requesting use of the local server as the
registry.

With this, the tests are entirely local. No external requests.

Also contains minor fix-ups to the test that were pointed out in #12983:

- Use 'require' in chdir
- Use subtests for `Test*Install`
- Don't send command output to /dev/null

These fix-ups are in separate commits to keep the meat of this change
independently reviewable.


Co-authored-by: Abhinav Gupta <abhinav@pulumi.com>
2023-05-29 18:29:29 +00:00
..
asset Apply autoformat 2023-04-28 18:27:10 -04:00
automation fix some links 2023-05-19 19:39:26 -07:00
cmd [sdk] Update uniseg 2023-05-25 22:24:13 -07:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Apply autoformat 2023-04-28 18:27:10 -04:00
iterable Apply autoformat 2023-04-28 18:27:10 -04:00
log Apply autoformat 2023-04-28 18:27:10 -04:00
npm Merge #13033 2023-05-29 18:29:29 +00:00
proto gRPC for GenerateProject/Program/Package 2023-05-06 13:14:59 +01:00
provider Apply autoformat 2023-04-28 18:27:10 -04:00
queryable This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
runtime Eliminate assignment statements used as expressions. 2023-05-15 19:48:47 -04:00
tests Merge #12916 2023-05-12 00:43:24 +00:00
tests_with_mocks Apply autoformat 2023-04-28 18:27:10 -04:00
.eslintrc.js Apply autoformat 2023-04-28 18:27:10 -04:00
.gitignore ci: Pin yarn lockfile for security & dependency scanning 2022-09-21 15:35:43 -07:00
Makefile Fix makefiles 2023-05-26 11:00:45 +01:00
README.md fix some links 2023-05-19 19:39:26 -07:00
config.ts Apply autoformat 2023-04-28 18:27:10 -04:00
errors.ts Remove Useless Constructors. 2023-05-15 19:48:47 -04:00
index.ts Removing x namespace from go/python/nodejs automation packages (#6518) 2021-04-14 19:32:18 +01:00
invoke.ts [sdk/nodejs] Add pluginServerURL (#8698) 2022-01-10 15:54:41 -08:00
metadata.ts Make getOrganization total, default to 'organization' 2022-09-22 11:06:51 -07:00
output.ts This commit safely replaces empty interfaces with type aliases. 2023-05-11 23:10:00 -04:00
package.json Upgrade Rome to v12.1.0 2023-05-15 19:48:29 -04:00
resource.ts Don't use the `delete` operator. 2023-04-28 22:07:35 -04:00
rome.json Remove Useless Constructors. 2023-05-15 19:48:47 -04:00
stackReference.ts Apply autoformat 2023-04-28 18:27:10 -04:00
tsconfig.json sdk/node/StackReference: Add getOutputDetails 2023-02-03 16:47:27 -08:00
tsutils.ts [sdk/nodejs] Mark internal APIs `@internal` to filter from SDK docs 2022-09-20 11:54:06 -07:00
utils.ts Apply autoformat 2023-04-28 18:27:10 -04:00
version.ts Add license headers 2018-05-22 15:02:47 -07:00
yarn.lock Upgrade Rome to v12.1.0 2023-05-15 19:48:29 -04:00

README.md

Pulumi Node.js SDK

The Pulumi Node.js SDK lets you write cloud programs in JavaScript.

Installation

Using npm:

$ npm install --save @pulumi/pulumi

Using yarn:

$ yarn add @pulumi/pulumi

This SDK is meant for use with the Pulumi CLI. Visit Pulumi's Download & Install to install the CLI.

Building and Testing

For anybody who wants to build from source, here is how you do it.

Prerequisites

This SDK uses Node.js and we support any of the Current, Active and Maintenance LTS versions. We support both NPM and Yarn for package management.

At the moment, we only support building on macOS and Linux, where standard GNU tools like make are available.

Make Targets

To build the SDK, simply run make from the root directory (where this README lives, at sdk/nodejs/ from the repo's root). This will build the code, run tests, and install the package and its supporting artifacts.

At the moment, for local development, we install everything into $HOME/.dev-pulumi. You will want this on your $PATH.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.