45064d6299
This change introduces the basic requirements for analyzers, as per pulumi/coconut#119. In particular, an analyzer can implement either, or both, of the RPC methods, Analyze and AnalyzeResource. The former is meant to check an overall deployment (e.g., to ensure it has been signed off on) and the latter is to check individual resources (e.g., to ensure properties of them are correct, such as checking style, security, etc. rules). These run simultaneous to overall checking. Analyzers are loaded as plugins just like providers are. The difference is mainly in their naming ("analyzer-" prefix, rather than "resource-"), and the RPC methods that they support. This isn't 100% functional since we need a way to specify at the CLI that a particular analyzer should be run, in addition to a way of recording which analyzers certain projects should use in their manifests. |
||
|---|---|---|
| cmd | ||
| docs | ||
| examples | ||
| lib | ||
| pkg | ||
| sdk | ||
| tools/cocojs | ||
| .gitignore | ||
| .gitmodules | ||
| glide.lock | ||
| glide.yaml | ||
| main.go | ||
| Makefile | ||
| README.md | ||
Coconut
Coconut is a framework and toolset for creating reusable stacks of services.
If you are learning about Coconut for the first time, please see the overview document.
Installing
To install Coconut from source, simply run:
$ go get -u github.com/pulumi/coconut
A GOPATH must be set. A good default value is ~/go. In fact, this is the default in Go 1.8.
It is common to alias the shorter command coco to the full binary coconut:
alias coco=coconut
At this moment, libraries must be manually installed. See below. Eventually we will have an installer.
Compilers
The Coconut compilers are independent from the core Coconut tools.
Please see the respective pages for details on how to install, build, and test each compiler:
Development
This section is for Coconut developers.
Prerequisites
Coconut is written in Go and uses Glide for dependency management. They must be installed:
If you wish to use the optional lint make target, you'll also need to install Golint:
$ go get -u github.com/golang/lint/golint
Building and Testing
To build Coconut, ensure $GOPATH is set, and clone into a standard Go workspace:
$ git clone git@github.com:pulumi/coconut $GOPATH/src/github.com/pulumi/coconut
At this point you should be able to build and run tests from the root directory:
$ cd $GOPATH/src/github.com/pulumi/coconut
$ glide update
$ make
This installs the coconut binary into $GOPATH/bin, which may now be run provided make exited successfully.
Installing the Runtime Libraries
By default, Coconut looks for its runtime libraries underneath /usr/local/coconut. $COCOPATH overrides this.
Please refer to the libraries README for details on additional installation requirements.
Debugging
The Coconut tools have extensive logging built in. In fact, we encourage liberal logging in new code, and addding 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 barebones, and adds basic leveled logging, stack dumping, and other capabilities beyond what Go's built-in logging routines offer.
The Coconut 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
$ coco eval --logtostderr -v=5
is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.