Go to file
Sean Gillespie 703a954839
Improve error messages output by the CLI (#1011)
* Improve error messages output by the CLI

This fixes a couple known issues with the way that we present errors
from the Pulumi CLI:
    1. Any errors from RPC endpoints were bubbling up as they were to
    the top-level, which was unfortunate because they contained
    RPC-specific noise that we don't want to present to the user. This
    commit unwraps errors from resource providers.
    2. The "catastrophic error" message often got printed twice
    3. Fatal errors are often printed twice, because our CLI top-level
    prints out the fatal error that it receives before exiting. A lot of
    the time this error has already been printed.
    4. Errors were prefixed by PU####.

* Feedback: Omit the 'catastrophic' error message and use a less verbose error message as the final error

* Code review feedback: interpretRPCError -> resourceStateAndError

* Code review feedback: deleting some commented-out code, error capitalization

* Cleanup after rebase
2018-03-09 15:43:16 -08:00
build Use test-failures scripts from pulumi/home 2018-03-08 11:40:17 -08:00
cmd Adds a pulumi new command to scaffold a project (#1008) 2018-03-09 15:27:55 -08:00
examples Remove the need for the :config: part of a config bag 2018-03-08 10:52:25 -08:00
pkg Improve error messages output by the CLI (#1011) 2018-03-09 15:43:16 -08:00
scripts Update PyPI publish source 2018-03-09 15:27:16 -08:00
sdk Reenable Pylint (#1024) 2018-03-09 15:11:37 -08:00
tests Adds a pulumi new command to scaffold a project (#1008) 2018-03-09 15:27:55 -08:00
.appveyor.yml Cleanup provider launch scripts and fix some windows build oddities 2018-02-15 17:02:35 -08:00
.gitignore Download and use a custom Node binary instead of linking against 2018-02-13 14:04:01 -08:00
.travis.yml Use test-failures scripts from pulumi/home 2018-03-08 11:40:17 -08:00
.yarnrc Pass --network-concurrency 1 to yarn 2018-01-29 11:49:42 -08:00
build.proj Make many fixes to closure serialization (#944) 2018-03-01 00:32:01 -08:00
CHANGELOG.md Use per stack key for local stacks instead of per project 2018-01-19 00:50:59 -08:00
CONTRIBUTING.md Remove a few outdated references (#997) 2018-03-04 13:34:20 -08:00
Gometalinter.json Add additional linting (#768) 2017-12-27 17:10:12 -08:00
Gopkg.lock Use os/user for home directory 2018-02-20 15:35:07 -08:00
Gopkg.toml Make some stack-related CLI improvements (#947) 2018-02-16 15:03:54 -08:00
LICENSE Clarify aspects of using the DCO 2017-06-26 14:46:34 -07:00
main.go Add a manifest to checkpoint files (#630) 2017-12-01 13:50:32 -08:00
Makefile Publish tgz's in the middle of the build, packages at the end 2018-03-06 19:20:47 -08:00
README.md Update README.md to use a valid CLI command 2018-02-22 14:26:04 -08: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 ensure to install dependencies and perform other machine setup:

$ make ensure

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_all or make test_fast), 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 preview --logtostderr -v=5

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