Go to file
Joe Duffy cdb2c79e8e
Exit with an error code in the face of unhandled errors (#495)
As part of fixing the exit bug recently, we accidentally made errors
lead to zero exit codes.  As a result, the Pulumi CLI thought the
prgoram exited ordinarily, and proceeded to do its usual planning and
deployment, rather than terminating abruptly.

This is a byproduct of how Node's process.uncaughtException handler
works.  It hijacks and replaces all usual error logic, including the
process.exit part.  This change simply adds back the non-zero exit.

I also added a test (and fixed one other that began failing
afterwards), so that we can prevent regressions down the road.
2017-10-28 17:05:05 -07:00
cmd Add newline after update completes (#487) 2017-10-27 15:40:15 -07:00
dist/sdk/nodejs Build, integration tests and publishing on Windows 2017-10-02 13:40:58 -07:00
examples Add minimal runtime verification test 2017-10-27 20:03:38 -07:00
pkg Add minimal runtime verification test 2017-10-27 20:03:38 -07:00
scripts Use install.sh 2017-10-14 07:24:20 -07:00
sdk Exit with an error code in the face of unhandled errors (#495) 2017-10-28 17:05:05 -07:00
.appveyor.yml Build, integration tests and publishing on Windows 2017-10-02 13:40:58 -07:00
.gitignore Revert "The Go vendoring saga continues" 2017-08-01 17:51:38 -07:00
.gitmodules Remove stale submodules 2017-05-15 10:33:22 -07:00
.travis.yml Stop using yarn scripts for building 2017-10-16 10:47:37 -07:00
.yarnrc Restore TESTPARALLELISM to 10 2017-10-16 10:47:37 -07:00
build.proj Lower timeout 2017-10-27 15:54:16 -07:00
CONTRIBUTING.md Adopt new pulumi/home repo name 2017-09-21 14:09:35 -07:00
Gometalinter.json Bump allowed line length to 140 characters 2017-10-09 18:21:55 -07:00
Gopkg.lock Move .pulumi to root of a repository 2017-10-27 11:46:21 -07:00
Gopkg.toml Use go-yaml directly 2017-10-20 14:01:37 -07:00
LICENSE Clarify aspects of using the DCO 2017-06-26 14:46:34 -07:00
main.go Construct version based on git information 2017-10-16 18:35:41 -07:00
Makefile Lower timeout 2017-10-27 15:54:16 -07:00
README.md Tidy up out of date documentation 2017-10-22 13:28:51 -07:00
tslint.json Enable 'use const' linter rule. (#405) 2017-10-10 14:50:55 -07:00

Pulumi Fabric

The Pulumi Fabric ("Pulumi") is a framework and toolset for creating reusable cloud services.

If you are learning about Pulumi for the first time, please visit our docs website.

Build Status

Architecture Build Status
Linux x64 Linux x64 Build Status
Windows x64 Windows x64 Build Status

Installing

To install Pulumi from source, simply run:

$ go get -u github.com/pulumi/pulumi

A GOPATH must be set. A good default value is ~/go. In fact, this is the default in Go 1.8.

This installs the pulumi binary to $GOPATH/bin.

To do anything interesting with Pulumi, you will need an SDK for your language of choice. Please see sdk/README.md for information about how to obtain, install, and use such an SDK.

Development

This section is for Pulumi developers.

Prerequisites

Pulumi is written in Go, uses Dep for dependency management, and GoMetaLinter for linting:

Building and Testing

To build Pulumi, ensure $GOPATH is set, and clone into a standard Go workspace:

$ git clone git@github.com:pulumi/pulumi $GOPATH/src/github.com/pulumi/pulumi
$ cd $GOPATH/src/github.com/pulumi/pulumi

The first time you build, you must make configure to install dependencies and perform other machine setup:

$ make configure

In the future, you can synch dependencies simply by running dep ensure explicitly:

$ dep ensure

At this point you can run make to build and run tests:

$ make

This installs the pulumi binary into $GOPATH/bin, which may now be run provided make exited successfully.

The Makefile also supports just running tests (make test), just running the linter (make lint), just running Govet (make vet), and so on. Please just refer to the Makefile for the full list of targets.

Debugging

The Pulumi tools have extensive logging built in. In fact, we encourage liberal logging in new code, and adding new logging when debugging problems. This helps to ensure future debugging endeavors benefit from your sleuthing.

All logging is done using Google's Glog library. It is relatively bare-bones, and adds basic leveled logging, stack dumping, and other capabilities beyond what Go's built-in logging routines offer.

The pulumi command line has two flags that control this logging and that can come in handy when debugging problems. The --logtostderr flag spews directly to stderr, rather than the default of logging to files in your temp directory. And the --verbose=n flag (-v=n for short) sets the logging level to n. Anything greater than 3 is reserved for debug-level logging, greater than 5 is going to be quite verbose, and anything beyond 7 is extremely noisy.

For example, the command

$ pulumi eval --logtostderr -v=5

is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.