add helpful console output, fix comments

Author: mattfenwick

pkg/cli/analyze.go

@@ -123,10 +123,13 @@ func RunAnalyzeCommand(args *AnalyzeArgs) {
 	for _, mode := range args.Modes {
 		switch mode {
 		case ParseMode:
+			fmt.Println("parsed policies:")
 			ParsePolicies(kubePolicies)
 		case ExplainMode:
+			fmt.Println("explained policies:")
 			ExplainPolicies(policies)
 		case LintMode:
+			fmt.Println("policy lint:")
 			Lint(kubePolicies)
 		case QueryTargetMode:
 			pods := make([]*QueryTargetPod, len(kubePods))
@@ -136,10 +139,13 @@ func RunAnalyzeCommand(args *AnalyzeArgs) {
 					Labels:    p.Labels,
 				}
 			}
+			fmt.Println("query target:")
 			QueryTargets(policies, args.TargetPodPath, pods)
 		case QueryTrafficMode:
+			fmt.Println("query traffic:")
 			QueryTraffic(policies, args.TrafficPath)
 		case ProbeMode:
+			fmt.Println("probe:")
 			ProbeSyntheticConnectivity(policies, args.ProbePath, kubePods, kubeNamespaces)
 		default:
 			panic(errors.Errorf("unrecognized mode %s", mode))

pkg/generator/action.go

@@ -2,7 +2,7 @@ package generator
 
 import networkingv1 "k8s.io/api/networking/v1"
 
-// Action: exactly one field must be non-null.  This models a discriminated union (sum type).
+// Action models a sum type (discriminated union): exactly one field must be non-null.
 type Action struct {
 	CreatePolicy *CreatePolicyAction
 	UpdatePolicy *UpdatePolicyAction

pkg/matcher/policy.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 )
 
-// This is the root type
+// Policy is the root type
 type Policy struct {
 	Ingress map[string]*Target
 	Egress  map[string]*Target

pkg/matcher/target.go

@@ -35,7 +35,7 @@ func (t *Target) Allows(peer *TrafficPeer, portInt int, portName string, protoco
 	return false
 }
 
-// CombinePeerMatchers creates a new Target combining the egress and ingress rules
+// Combine creates a new Target combining the egress and ingress rules
 // of the two original targets.  Neither input is modified.
 // The Primary Keys of the two targets must match.
 func (t *Target) Combine(other *Target) *Target {
@@ -53,7 +53,7 @@ func (t *Target) Combine(other *Target) *Target {
 	}
 }
 
-// The primary key is a deterministic combination of PodSelector and namespace
+// GetPrimaryKey returns a deterministic combination of PodSelector and namespace
 func (t *Target) GetPrimaryKey() string {
 	if t.primaryKey == "" {
 		t.primaryKey = fmt.Sprintf(`{"Namespace": "%s", "PodSelector": %s}`, t.Namespace, kube.SerializeLabelSelector(t.PodSelector))