gometalinter

Author: liamsi

cmd/keytransparency-monitor/main.go

@@ -35,8 +35,8 @@ import (
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/reflection"
 
-	"github.com/google/keytransparency/core/monitor/storage"
 	cmon "github.com/google/keytransparency/core/monitor"
+	"github.com/google/keytransparency/core/monitor/storage"
 	kpb "github.com/google/keytransparency/core/proto/keytransparency_v1_types"
 	"github.com/google/keytransparency/impl/monitor/client"
 	spb "github.com/google/keytransparency/impl/proto/keytransparency_v1_service"

core/monitor/monitor.go

@@ -25,9 +25,9 @@ import (
 	ktpb "github.com/google/keytransparency/core/proto/keytransparency_v1_types"
 
 	"github.com/google/trillian"
+	tcrypto "github.com/google/trillian/crypto"
 	"github.com/google/trillian/merkle"
 	"github.com/google/trillian/merkle/hashers"
-	tcrypto "github.com/google/trillian/crypto"
 )
 
 // Monitor holds the internal state for a monitor accessing the mutations API
@@ -63,11 +63,14 @@ func New(logTree, mapTree *trillian.Tree, signer *tcrypto.Signer, store *storage
 	}, nil
 }
 
+// Process processes a mutation response received from the keytransparency
+// server. Processing includes verifying, signing and storing the resulting
+// monitoring response.
 func (m *Monitor) Process(resp *ktpb.GetMutationsResponse) error {
 	var smr *trillian.SignedMapRoot
 	var err error
 	seen := time.Now().Unix()
-	errs := m.VerifyMutationsResponse(resp)
+	errs := m.verifyMutationsResponse(resp)
 	if len(errs) == 0 {
 		glog.Infof("Successfully verified mutations response for epoch: %v", resp.Epoch)
 		smr, err = m.signMapRoot(resp)

core/monitor/storage/storage.go

@@ -22,31 +22,45 @@ import (
 )
 
 var (
+	// ErrAlreadyStored is raised if the caller tries storing a response which
+	// has already been stored.
 	ErrAlreadyStored = errors.New("already stored epoch")
-	ErrNotFound      = errors.New("data for epoch not found")
+	// ErrNotFound is raised if the caller tries to retrieve data for an epoch
+	// which has not been processed and stored yet.
+	ErrNotFound = errors.New("data for epoch not found")
 )
 
+// MonitoringResult stores all data
 type MonitoringResult struct {
-	// in case of success this contains the map root signed by the monitor
+	// Smr contains the map root signed by the monitor in case all verifications
+	// have passed.
 	Smr *trillian.SignedMapRoot
-	// response contains the original mutations API response from the server
-	// in case at least one verification step failed
+	// Seen is the the unix timestamp at which the mutations response has been
+	// received.
+	Seen int64
+	// Errors contains a string representation of the verifications steps that
+	// failed.
+	Errors []error
+	// Response contains the original mutations API response from the server
+	// in case at least one verification step failed.
 	Response *ktpb.GetMutationsResponse
-	Seen     int64
-	Errors   []error
 }
 
+// Storage is an in-memory store for the monitoring results.
 type Storage struct {
-	store map[int64]*MonitoringResult
+	store  map[int64]*MonitoringResult
 	latest int64
 }
 
+// New initializes a
 func New() *Storage {
 	return &Storage{
 		store: make(map[int64]*MonitoringResult),
 	}
 }
 
+// Set internally stores the given data as a MonitoringResult which can be
+// retrieved by Get.
 func (s *Storage) Set(epoch int64,
 	seenNanos int64,
 	smr *trillian.SignedMapRoot,
@@ -63,17 +77,20 @@ func (s *Storage) Set(epoch int64,
 		Response: response,
 		Errors:   errorList,
 	}
-	s.latest=epoch
+	s.latest = epoch
 	return nil
 }
 
+// Get returns the MonitoringResult for the given epoch. It returns an error
+// if the result does not exist.
 func (s *Storage) Get(epoch int64) (*MonitoringResult, error) {
 	if result, ok := s.store[epoch]; ok {
 		return result, nil
 	}
 	return nil, ErrNotFound
 }
 
+// LatestEpoch is a convenience method to retrieve the latest stored epoch.
 func (s *Storage) LatestEpoch() int64 {
 	return s.latest
 }

core/monitor/verify.go

@@ -21,11 +21,11 @@ import (
 	ktpb "github.com/google/keytransparency/core/proto/keytransparency_v1_types"
 )
 
-// VerifyResponse verifies a response received by the GetMutations API.
+// verifyMutationsResponse verifies a response received by the GetMutations API.
 // Additionally to the response it takes a complete list of mutations. The list
 // of received mutations may differ from those included in the initial response
 // because of the max. page size. If any verification check failed it returns
 // an error.
-func (m *Monitor) VerifyMutationsResponse(in *ktpb.GetMutationsResponse) []error {
+func (m *Monitor) verifyMutationsResponse(in *ktpb.GetMutationsResponse) []error {
 	return nil
 }

impl/monitor/client/client.go

@@ -15,7 +15,7 @@
 package client
 
 //
-// This file contains Monitor's grpc client logic: poll mutations from the
+// This file contains Monitor'c grpc client logic: poll mutations from the
 // kt-server mutations API and page if necessary.
 //
 
@@ -44,7 +44,7 @@ type Client struct {
 // New initializes a new mutations API monitoring client.
 func New(client mupb.MutationServiceClient, pollPeriod time.Duration) *Client {
 	return &Client{
-		client: client,
+		client:     client,
 		pollPeriod: pollPeriod,
 	}
 }
@@ -80,10 +80,10 @@ func (c *Client) StartPolling(startEpoch int64) (<-chan *ktpb.GetMutationsRespon
 	return response, errChan
 }
 
-func (s *Client) pollMutations(ctx context.Context,
+func (c *Client) pollMutations(ctx context.Context,
 	queryEpoch int64,
 	opts ...grpc.CallOption) (*ktpb.GetMutationsResponse, error) {
-	response, err := s.client.GetMutations(ctx, &ktpb.GetMutationsRequest{
+	response, err := c.client.GetMutations(ctx, &ktpb.GetMutationsRequest{
 		PageSize: pageSize,
 		Epoch:    queryEpoch,
 	}, opts...)
@@ -94,7 +94,7 @@ func (s *Client) pollMutations(ctx context.Context,
 	// Page if necessary: query all mutations in the current epoch
 	for response.GetNextPageToken() != "" {
 		req := &ktpb.GetMutationsRequest{PageSize: pageSize}
-		resp, err := s.client.GetMutations(ctx, req, opts...)
+		resp, err := c.client.GetMutations(ctx, req, opts...)
 		if err != nil {
 			return nil, err
 		}

impl/monitor/server.go

@@ -1,3 +1,24 @@
+// Copyright 2017 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package monitor implements the monitor service. A monitor repeatedly polls a
+// key-transparency server's Mutations API and signs Map Roots if it could
+// reconstruct
+// clients can query.
+
+// Package monitor contains an implementation of a Monitor server which can be
+// queried for monitoring results.
 package monitor
 
 import (
@@ -67,8 +88,8 @@ func (s *Server) getResponseByRevision(epoch int64) (*mopb.GetMonitoringResponse
 	}
 
 	if len(res.Errors) > 0 {
-		for _, err := range resp.Errors {
-			resp.Errors = append(resp.Errors, err)
+		for _, err := range res.Errors {
+			resp.Errors = append(resp.Errors, err.Error())
 		}
 		// data to replay the verification steps:
 		resp.ErrorData = res.Response