Editing the HTML Templates

The generated HTML views are stored inside the compiled binary to ease deployment. If you wish to tweak the look & feel by editing them then you're more then welcome.

The raw HTML-templates are located beneath data/, and you can edit them then rebuild the compiled versions via implant.

If you don't already have implant installed fetch it like so:

 go get -u github.com/skx/implant/

Now regenerate the compiled version(s) of the templates and rebuild the binary to make your changes:

implant -input data/ -output static.go
go build .

Test Coverage

To test the coverage of the test-suite you can use the cover tool:

 go get golang.org/x/tools/cmd/cover
 go test -coverprofile fmt

Once you've done that you can view the coverage of various functions via:

 go tool cover -func=fmt

To view the coverage report in HTML, via your browser this is good:

 go test -coverprofile=cover.out
 go tool cover -html=cover.out -o foo.html
 firefox foo.html

Running a container

This project now ships a Dockerfile. The goal is to build a small image with puppet-summary installed on it. This uses multi-stage builds for docker and thus requires docker version 17.05 or higher. The container is based on alpine linux and should be around 20MB.

To build:

docker build -t puppet-summary:<current version> .

To run:

docker run -d -v app:/app -p 3001:3001 puppet-summary

NOTE: When running in a container the -auto-prune flag is applied, with the intention that reports will be pruned on a weekly basis.

Cross compiling puppet-summary

In this example, the compilation is happening on x86_64 Fedora or a Debian 9 amd64 system with a target of Raspbian on ARM (raspberry PI).

Install the packages you need.

Fedora

# dnf install binutils-arm-linux-gnu cross-gcc-common cross-binutils-common gcc-c++-arm-linux-gnu kernel-cross-headers glibc-arm-linux-gnu glibc-arm-linux-gnu-devel

Debian

# apt-get install cpp-6-arm-linux-gnueabihf g++-6-arm-linux-gnueabihf gcc-6-arm-linux-gnueabihf gcc-6-arm-linux-gnueabihf-base gccgo-6-arm-linux-gnueabihf

Manually fix pthreads

Note: This is only required on Fedora builders.

The way cgo works for cross compiles, it assumes a sysroot, which is normal. However, the way pthreads is called in the github.com/mattn/go-sqlite3 package, it requires and absolute path, but that path is relative to the sysroot provided.

# pushd /usr/arm-linux-gnu; ln -s /usr .; popd

Compile

I use -v when cross compiling because it will give much more info if something errors out.

Fedora

$ CC=arm-linux-gnu-gcc CGO_ENABLED=1 GOOS=linux GOARCH=arm CGO_LDFLAGS=--sysroot=/usr/arm-linux-gnu CGO_CFLAGS=--sysroot=/usr/arm-linux-gnu go build -v .

Debian

$ CC=arm-linux-gnueabihf-gcc-6 CGO_ENABLED=1 GOOS=linux GOARCH=arm CGO_LDFLAGS=--sysroot=/usr/arm-linux-gnu CGO_CFLAGS=--sysroot=/usr/arm-linux-gnu go build -v .

Verify build

You should have a generated binary now, which you can inspect via:

$ file puppet-summary

This should show something like:

puppet-summary: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0, BuildID[sha1]=810382dc0c531df0de230c2f681925d9ebf59fd6, with debug_info, not stripped