Comment grammar and removing a renaming

Author: beautifulentropy

va/proto/va.proto

@@ -5,21 +5,23 @@ option go_package = "github.com/letsencrypt/boulder/va/proto";
 
 import "core/proto/core.proto";
 
+// PerformValidation performs a local Domain Control Validation (DCV) and CAA
+// check for the provided challenge and dnsName. If called on the primary VA and
+// local validation passes, it will also perform DCV and CAA checks using the
+// configured remote VAs. It returns a validation result and an error if the
+// validation failed. The returned result will always contain a list of
+// validation records, even when it also contains a problem. This method is not
+// MPIC-compliant.
+//
+// DoDCV performs a local Domain Control Validation (DCV) for the provided
+// challenge. If called on the primary VA and local validation passes, it will
+// also perform an MPIC-compliant DCV using the configured remote VAs. It
+// returns a validation result and an error if the validation failed. The
+// returned result will always contain a list of validation records, even when
+// it also contains a problem. This method does not check CAA records and should
+// not be used as a replacement for VA.PerformValidation.
 service VA {
-  // PerformValidation performs a local Domain Control Validation (DCV) and CAA
-  // check for the provided challenge and dnsName. If called on the primary VA
-  // and local validation passes, it will also perform DCV and CAA checks using
-  // the configured remote VAs. The returned result will always contain a list
-  // of validation records, even when it also contains a problem. This method is
-  // not MPIC-compliant.  
   rpc PerformValidation(PerformValidationRequest) returns (ValidationResult) {}
-  // DoDCV performs a local Domain Control Validation (DCV) for the provided
-  // challenge. If called on the primary VA and local validation passes, it will
-  // also perform an MPIC-compliant DCV using the configured remote VAs. The
-  // method returns the validation result and an error if the validation failed.
-  // The returned result will always contain a list of validation records, even
-  // when it also contains a problem. This method does not check CAA records and
-  // should not be used as a replacement for VA.PerformValidation.
   rpc DoDCV(DCVRequest) returns (ValidationResult) {}
 }
 

va/va.go

@@ -657,7 +657,8 @@ func (va *ValidationAuthorityImpl) performLocalValidation(
 // PerformValidation performs a local Domain Control Validation (DCV) and CAA
 // check for the provided challenge and dnsName. If called on the primary VA and
 // local validation passes, it will also perform DCV and CAA checks using the
-// configured remote VAs. The returned result will always contain a list of
+// configured remote VAs. It returns a validation result and an error if the
+// validation failed. The returned result will always contain a list of
 // validation records, even when it also contains a problem. This method is not
 // MPIC-compliant.
 func (va *ValidationAuthorityImpl) PerformValidation(ctx context.Context, req *vapb.PerformValidationRequest) (*vapb.ValidationResult, error) {

va/va_test.go

@@ -197,19 +197,19 @@ func httpMultiSrv(t *testing.T, token string, allowedUAs map[string]bool) *multi
 	return ms
 }
 
-// canceledVA is a mock that always returns context.Canceled for
+// cancelledVA is a mock that always returns context.Canceled for
 // PerformValidation calls
-type canceledVA struct{}
+type cancelledVA struct{}
 
-func (v canceledVA) PerformValidation(_ context.Context, _ *vapb.PerformValidationRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
+func (v cancelledVA) PerformValidation(_ context.Context, _ *vapb.PerformValidationRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
 	return nil, context.Canceled
 }
 
-func (v canceledVA) IsCAAValid(_ context.Context, _ *vapb.IsCAAValidRequest, _ ...grpc.CallOption) (*vapb.IsCAAValidResponse, error) {
+func (v cancelledVA) IsCAAValid(_ context.Context, _ *vapb.IsCAAValidRequest, _ ...grpc.CallOption) (*vapb.IsCAAValidResponse, error) {
 	return nil, context.Canceled
 }
 
-func (v canceledVA) DoDCV(_ context.Context, _ *vapb.DCVRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
+func (v cancelledVA) DoDCV(_ context.Context, _ *vapb.DCVRequest, _ ...grpc.CallOption) (*vapb.ValidationResult, error) {
 	return nil, context.Canceled
 }
 
@@ -396,8 +396,8 @@ func TestMultiVA(t *testing.T) {
 		CAAClient: brokenRemoteVA{},
 	}
 	cancelledVA := RemoteClients{
-		VAClient:  canceledVA{},
-		CAAClient: canceledVA{},
+		VAClient:  cancelledVA{},
+		CAAClient: cancelledVA{},
 	}
 
 	unauthorized := probs.Unauthorized(fmt.Sprintf(
@@ -822,7 +822,7 @@ func setupRVAs(confs []rvaConf, mockDNSClient bdns.Client, srv *httptest.Server)
 	return remoteVAs
 }
 
-func createValidationRequest(domain string, challengeType core.AcmeChallenge) *vapb.DCVRequest {
+func createDoDCVRequest(domain string, challengeType core.AcmeChallenge) *vapb.DCVRequest {
 	return &vapb.DCVRequest{
 		Identifier: &corepb.Identifier{
 			Type:  string(identifier.TypeDNS),
@@ -843,7 +843,7 @@ func TestDoDCVInvalid(t *testing.T) {
 	rvas := setupRVAs([]rvaConf{{rir: "ARIN"}, {rir: "RIPE"}, {rir: "APNIC"}}, nil, nil)
 	va, mockLog := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("foo.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("foo.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "DoDCV failed, expected success")
@@ -867,7 +867,7 @@ func TestDoDCVInternalErrorLogged(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond)
 	defer cancel()
 
-	req := createValidationRequest("nonexistent.com", core.ChallengeTypeHTTP01)
+	req := createDoDCVRequest("nonexistent.com", core.ChallengeTypeHTTP01)
 
 	_, err := va.DoDCV(ctx, req)
 	test.AssertNotError(t, err, "Failed validation should be a prob but not an error")
@@ -887,7 +887,7 @@ func TestDoDCVValid(t *testing.T) {
 	rvas := setupRVAs([]rvaConf{{rir: "ARIN"}, {rir: "RIPE"}, {rir: "APNIC"}}, nil, nil)
 	va, mockLog := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "validating challenge resulted in unexpected error")
@@ -910,7 +910,7 @@ func TestDoDCVWildcard(t *testing.T) {
 	rvas := setupRVAs([]rvaConf{{rir: "ARIN"}, {rir: "RIPE"}, {rir: "APNIC"}}, nil, nil)
 	va, mockLog := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("*.good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("*.good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, _ := va.DoDCV(context.Background(), req)
 	test.Assert(t, res.Problems == nil, fmt.Sprintf("validation failed: %#v", res.Problems))
@@ -937,7 +937,7 @@ func TestDoDCVValidWithBrokenRVA(t *testing.T) {
 	rvas = append(rvas, RemoteVA{brokenRVA, "broken"})
 	va, _ := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "validating challenge resulted in unexpected error")
@@ -946,11 +946,11 @@ func TestDoDCVValidWithBrokenRVA(t *testing.T) {
 
 func TestDoDCVValidWithCancelledRVA(t *testing.T) {
 	rvas := setupRVAs([]rvaConf{{rir: "ARIN"}, {rir: "RIPE"}}, nil, nil)
-	cancelledRVA := RemoteClients{VAClient: canceledVA{}, CAAClient: canceledVA{}}
+	cancelledRVA := RemoteClients{VAClient: cancelledVA{}, CAAClient: cancelledVA{}}
 	rvas = append(rvas, RemoteVA{cancelledRVA, "cancelled"})
 	va, _ := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "validating challenge resulted in unexpected error")
@@ -963,7 +963,7 @@ func TestDoDCVFailsWithTooManyBrokenRVAs(t *testing.T) {
 	rvas = append(rvas, RemoteVA{brokenRVA, "broken"}, RemoteVA{brokenRVA, "broken"})
 	va, _ := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "Failed validation should be a prob but not an error")
@@ -979,11 +979,11 @@ func TestDoDCVFailsWithTooManyBrokenRVAs(t *testing.T) {
 
 func TestDoDCVFailsWithTooManyCanceledRVAs(t *testing.T) {
 	rvas := setupRVAs([]rvaConf{{rir: "ARIN"}}, nil, nil)
-	canceledRVA := RemoteClients{VAClient: canceledVA{}, CAAClient: canceledVA{}}
-	rvas = append(rvas, RemoteVA{canceledRVA, "canceled"}, RemoteVA{canceledRVA, "canceled"})
+	canceledRVA := RemoteClients{VAClient: cancelledVA{}, CAAClient: cancelledVA{}}
+	rvas = append(rvas, RemoteVA{canceledRVA, "cancelled"}, RemoteVA{canceledRVA, "cancelled"})
 	va, _ := setupVA(nil, "", rvas, nil)
 
-	req := createValidationRequest("good-dns01.com", core.ChallengeTypeDNS01)
+	req := createDoDCVRequest("good-dns01.com", core.ChallengeTypeDNS01)
 
 	res, err := va.DoDCV(context.Background(), req)
 	test.AssertNotError(t, err, "Failed validation should be a prob but not an error")
@@ -1019,7 +1019,7 @@ func parseMPICSummary(t *testing.T, log []string) mpicSummary {
 }
 
 func TestDoDCVMPIC(t *testing.T) {
-	req := createValidationRequest("localhost", core.ChallengeTypeHTTP01)
+	req := createDoDCVRequest("localhost", core.ChallengeTypeHTTP01)
 
 	// srv is used for the Primary VA and the Remote VAs. The srv.Server
 	// produced will be used to mock the challenge recipient. When a VA (primary

va/vampic.go

@@ -52,8 +52,8 @@ func (va *ValidationAuthorityImpl) isPrimaryVA() bool {
 	return va.perspective == PrimaryPerspective
 }
 
-// mpicSummary is returned by remoteValidateChallenge and contains a summary of
-// the validation results for logging purposes. Use prepareSummary() to create a
+// mpicSummary is returned by remoteDoDCV and contains a summary of the
+// validation results for logging purposes. Use prepareSummary() to create a
 // final summary to avoid "null" in JSON output.
 type mpicSummary struct {
 	// Passed are the distinct perspectives that Passed validation.
@@ -237,11 +237,11 @@ func (va *ValidationAuthorityImpl) remoteDoDCV(ctx context.Context, req *vapb.DC
 
 // DoDCV performs a local Domain Control Validation (DCV) for the provided
 // challenge. If called on the primary VA and local validation passes, it will
-// also perform an MPIC-compliant DCV using the configured remote VAs. The
-// method returns the validation result and an error if the validation failed.
-// The returned result will always contain a list of validation records, even
-// when it also contains a problem. This method does not check CAA records and
-// should not be used as a replacement for VA.PerformValidation.
+// also perform an MPIC-compliant DCV using the configured remote VAs. It
+// returns a validation result and an error if the validation failed. The
+// returned result will always contain a list of validation records, even when
+// it also contains a problem. This method does not check CAA records and should
+// not be used as a replacement for VA.PerformValidation.
 //
 // Note: When called on the primary VA, this method will also call itself over
 // gRPC on each remote VA.