8b57310854
This change fixes a few things:
* Most importantly, we need to place a leading "." in the paths
to Gometalinter, otherwise some sub-linters just silently skip
the directory altogether. errcheck is one such linter, which
is a very important one!
* Use an explicit Gometalinter.json file to configure the various
settings. This flips on a few additional linters that aren't
on by default (line line length checking). Sadly, a few that
I'd like to enable take waaaay too much time, so in the future
we may consider a nightly job (this includes code similarity,
unused parameters, unused functions, and others that generally
require global analysis).
* Now that we're running more, however, linting takes a while!
The core Lumi project now takes 26 seconds to lint on my laptop.
That's not terrible, but it's long enough that we don't want to
do the silly "run them twice" thing our Makefiles were previously
doing. Instead, we shall deploy some $$($${PIPESTATUS[1]}-1))-fu
to rely on the fact that grep returns 1 on "zero lines".
* Finally, fix the many issues that this turned up.
I think(?) we are done, except, of course, for needing to drive
down some of the cyclomatic complexity issues (which I'm possibly
going to punt on; see pulumi/lumi#259 for more details).
|
||
|---|---|---|
| cmd | ||
| docs | ||
| examples | ||
| Godeps | ||
| lib | ||
| pkg | ||
| sdk | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| Gometalinter.json | ||
| LICENSE | ||
| Makefile | ||
| NOTICE | ||
| README.md | ||
| tslint.json | ||
Lumi
Lumi is a framework and toolset for creating reusable cloud services.
If you are learning about Lumi for the first time, please see the overview document.
Installing
To install Lumi from source, simply run:
$ go get -u github.com/pulumi/lumi/cmd/lumi
A GOPATH must be set. A good default value is ~/go. In fact, this is the default in Go 1.8.
This installs the lumi binary to $GOPATH/bin.
At this moment, libraries must be manually installed. See below. Eventually we will have an installer.
Compilers
The Lumi compilers are independent from the core Lumi tools.
Please see the respective pages for details on how to install, build, and test each compiler:
Development
This section is for Lumi developers.
Prerequisites
Lumi is written in Go, uses Godep for dependency management, and GoMetaLinter for linting:
- Go: https://golang.org/dl
- Godep:
$ go get -v github.com/tools/godep - GoMetaLinter:
$ go get -v github.com/alecthomas/gometalinter$ gometalinter --install
Building and Testing
To build Lumi, ensure $GOPATH is set, and clone into a standard Go workspace:
$ git clone git@github.com:pulumi/lumi $GOPATH/src/github.com/pulumi/lumi
$ cd $GOPATH/src/github.com/pulumi/lumi
Before building, you will need to ensure dependencies have been restored to your enlistment:
$ godep restore
At this point you can run make to build and run tests:
$ make
This installs the lumi 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.
Installing the Runtime Libraries
By default, Lumi looks for its runtime libraries underneath /usr/local/lumi. $LUMIPATH overrides this.
Please refer to the libraries README for details on additional installation requirements.
Debugging
The Lumi 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 Lumi 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
$ lumi eval --logtostderr -v=5
is a pretty standard starting point during debugging that will show a fairly comprehensive trace log of a compilation.