lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

test: Add a check for too long or badly reflowed docstrings

Browse Source 
This ensures that docstring comments are wrapped to 80 chars. ffrank
seemed to be making this mistake far too often, and it's a silly thing
to look for manually. As it turns out, I've made it too, as have many
others. Now we have a test that checks for most cases. There are still a
few stray cases that aren't checked automatically, but this can be
improved upon if someone is motivated to do so.

Before anyone complains about the 80 character limit: this only checks
docstring comments, not source code length or inline source code
comments. There's no excuse for having docstrings that are badly
reflowed or over 80 chars, particularly if you have an automated test.
This commit is contained in:
James Shubin
2020-01-25 04:05:43 -05:00
parent 525e2bafee
commit f67ad9c061
73 changed files with 775 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
prometheus/prometheus.go
View File

@@ -46,8 +46,8 @@ const (
ResStateHardFail
)
// Prometheus is the struct that contains information about the
// prometheus instance. Run Init() on it.
// Prometheus is the struct that contains information about the prometheus
// instance. Run Init() on it.
type Prometheus struct {
Listen string // the listen specification for the net/http server
@@ -133,8 +133,8 @@ func (obj *Prometheus) Init() error {
return nil
}
// Start runs a http server in a go routine, that responds to /metrics
// as prometheus would expect.
// Start runs a http server in a go routine, that responds to /metrics as
// prometheus would expect.
func (obj *Prometheus) Start() error {
http.Handle("/metrics", promhttp.Handler())
go http.ListenAndServe(obj.Listen, nil)
@@ -148,8 +148,8 @@ func (obj *Prometheus) Stop() error {
return nil
}
// InitKindMetrics initialized prometheus counters. For each kind of
// resource checkApply counters are initialized with all the possible value.
// InitKindMetrics initialized prometheus counters. For each kind of resource,
// checkApply counters are initialized with all the possible value.
func (obj *Prometheus) InitKindMetrics(kinds []string) error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus
@@ -194,8 +194,8 @@ func (obj *Prometheus) UpdateCheckApplyTotal(kind string, apply, eventful, error
return nil
}
// UpdatePgraphStartTime updates the mgmt_graph_start_time_seconds metric
// to the current timestamp.
// UpdatePgraphStartTime updates the mgmt_graph_start_time_seconds metric to the
// current timestamp.
func (obj *Prometheus) UpdatePgraphStartTime() error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus
@@ -204,7 +204,8 @@ func (obj *Prometheus) UpdatePgraphStartTime() error {
return nil
}
// AddManagedResource increments the Managed Resource counter and updates the resource status.
// AddManagedResource increments the Managed Resource counter and updates the
// resource status.
func (obj *Prometheus) AddManagedResource(resUUID string, rtype string) error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus
@@ -216,7 +217,8 @@ func (obj *Prometheus) AddManagedResource(resUUID string, rtype string) error {
return nil
}
// RemoveManagedResource decrements the Managed Resource counter and updates the resource status.
// RemoveManagedResource decrements the Managed Resource counter and updates the
// resource status.
func (obj *Prometheus) RemoveManagedResource(resUUID string, rtype string) error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus
@@ -228,7 +230,8 @@ func (obj *Prometheus) RemoveManagedResource(resUUID string, rtype string) error
return nil
}
// deleteState removes the resources for the state map and re-populates the failing gauge.
// deleteState removes the resources for the state map and re-populates the
// failing gauge.
func (obj *Prometheus) deleteState(resUUID string) error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus
@@ -242,8 +245,8 @@ func (obj *Prometheus) deleteState(resUUID string) error {
return nil
}
// UpdateState updates the state of the resources in our internal state map
// then triggers a refresh of the failing gauge.
// UpdateState updates the state of the resources in our internal state map then
// triggers a refresh of the failing gauge.
func (obj *Prometheus) UpdateState(resUUID string, rtype string, newState ResState) error {
defer obj.updateFailingGauge()
if obj == nil {
@@ -266,8 +269,8 @@ func (obj *Prometheus) UpdateState(resUUID string, rtype string, newState ResSta
return nil
}
// updateFailingGauge refreshes the failing gauge by parsking the internal
// state map.
// updateFailingGauge refreshes the failing gauge by parsking the internal state
// map.
func (obj *Prometheus) updateFailingGauge() error {
if obj == nil {
return nil // happens when mgmt is launched without --prometheus

4
prometheus/prometheus_test.go
View File

@@ -25,8 +25,8 @@ import (
"github.com/prometheus/client_golang/prometheus"
)
// TestInitKindMetrics tests that we are initializing the Prometheus
// metrics correctly for all kind of resources.
// TestInitKindMetrics tests that we are initializing the Prometheus metrics
// correctly for all kinds of resources.
func TestInitKindMetrics(t *testing.T) {
var prom Prometheus
prom.Init()