m-lab / github-maintenance-exporter / 175

99%

push

travis-ci-com

Adds a new siteinfo package (#40)

* Adds a new siteinfo package

This new siteinfo package will be used by the maintenancestate package
to determine how many machines a site has when a site is being put into
maintenance and GMX needs to put all of the sites machines into
maintenance without also putting nonexistent ones into maintenance too.

* Updates Go modules, and Go to v1.17 in builds

* Removes unused 'url' param to Reload()

* Adds unit testing to the Reload() function

Part of making this happen was to add a new field to the SiteinfoClient
struct to hold a siteinfo.Client.

Note: there is an unfortunate name collision between this package and
go/siteinfo.

* Removes comment that is no longer applicable

* Moves test error case to its own test/function

* Updates Go to v1.18 in the Travis build env

Also, uses go-install instead of go-get to install goveralls, since
go-get in v1.18 no longer builds a binary.

* Refactors the new siteinfo package a bit

* Changes naming of various types and variables
* Moves Siteinfo interface to the maintenancestate package
* Testing now uses the new m-lab/go/siteinfo/siteinfotest package for
  useful types for testing
* A couple small changes based on PR comments

* Renames to the "siteinfo" package to just "sites"

The name "siteinfo" collided with m-lab/go/siteinfo, which this package
uses. "sites" is a little more generic, and avoids the awkward name
collision.

* Renames struct from Siteinfo to CachingClient

* Adds mutex locks for both sites methods

Adds locks for both the `Machines()` and `Reload()` methods to be sure
that no reading or writing can happen simultaneously.

* Reorders fields in CachingClient struct

Alphabetically orders exported fields and puts single unexported field
last.

27 of 27 new or added lines in 1 file covered. (100.0%)

328 of 328 relevant lines covered (100.0%)

1.13 hits per line