6f0ee42b7c
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> |
||
---|---|---|
.. | ||
asset | ||
automation | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
npm | ||
proto | ||
provider | ||
queryable | ||
runtime | ||
tests | ||
tests_with_mocks | ||
.eslintrc.js | ||
.gitignore | ||
Makefile | ||
README.md | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
output.ts | ||
package.json | ||
resource.ts | ||
rome.json | ||
stackReference.ts | ||
tsconfig.json | ||
tsutils.ts | ||
utils.ts | ||
version.ts | ||
yarn.lock |
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.