Periodic spellcheck (#2612)

* cspell exception updates

Signed-off-by: michael sorens <[email protected]>

* Add spellcheck to authz and ui makefiles

Signed-off-by: michael sorens <[email protected]>

* Spelling corrections

Signed-off-by: michael sorens <[email protected]>

* UI spelling fixes

Signed-off-by: michael sorens <[email protected]>

* Customization for automate-chef-io

Migrated file selection recently added to automate-chef-io/Makefile

Signed-off-by: michael sorens <[email protected]>

* Revert "Add spellcheck to authz and ui makefiles"

This reverts commit 7660429.
Moving to common makefile instead.

* Add common spell target to makefiles

Signed-off-by: michael sorens <[email protected]>

* Remove exception for contraction

Signed-off-by: michael sorens <[email protected]>

* Revise and comment local spellcheck

This one components uses a custom spellchec as well;
renaming it and commenting just for clarity.

Signed-off-by: michael sorens <[email protected]>

* Couple more catches

Signed-off-by: michael sorens <[email protected]>

Author: msorens

.studiorc

@@ -20,7 +20,7 @@ else
 fi
 
 # Install busybox-static so script evaluations (e.g. #!/bin/bash) will work
-# This ensures normal linxu studios work like Docker studios
+# This ensures normal linux studios work like Docker studios
 log_line "Install busybox-static & bash hart packages"
 hab pkg install core/busybox-static >/dev/null
 hab pkg binlink -d /bin core/busybox-static >/dev/null

Makefile.common_go

@@ -2,6 +2,10 @@
 # components/xyz-service/Makefile
 REPOROOT?=../..
 
+# Convert, e.g., "src/github.com/chef/automate/components/teams-service" to "components/teams-service"
+REPO_DIR := $(shell cd $(REPOROOT) && pwd)/
+COMPONENT_DIR := $(shell echo $${PWD\#"$(REPO_DIR)"})
+
 LIBRARY_PATH = github.com/chef/automate/lib
 
 UNAME_S:=$(shell uname -s)
@@ -37,4 +41,11 @@ fmt:
 fmt-check:
 	@test -z $(shell gofmt -l ./cmd/ ./pkg/)
 
+spell:
+	@pushd $(REPOROOT) > /dev/null; \
+	./scripts/spellcheck.sh --wordsOnly $(COMPONENT_DIR); \
+	EXIT_CODE=$$?; \
+	popd > /dev/null; \
+	exit $$EXIT_CODE
+
 .PHONY: lint fmt fmt-check golang_version_check

components/applications-service/cmd/applications-publisher/main.go

@@ -143,7 +143,7 @@ func main() {
 	)
 
 	// In habitat, the wrappers.StringValue for stdout and stderr will be nil
-	// pointers when there's no content (e.g., a package without a healhcheck
+	// pointers when there's no content (e.g., a package without a healthcheck
 	// command/script). To mimic that behavior we need to initialize the
 	// optionalString variables here with nil pointers for their StringValue
 	// elements.

components/authn-service/tokens/pg/pg_test.go

@@ -595,7 +595,7 @@ func TestPurgeProject(t *testing.T) {
 			assert.NoError(err, "failed to get token")
 			assert.ElementsMatch([]string{"otherproject", "otherproject2"}, purgeCheck.Projects)
 		},
-		"when there are mulitple tokens, some with, some without the project to purge": func(t *testing.T) {
+		"when there are multiple tokens, some with, some without the project to purge": func(t *testing.T) {
 			id1 := "other_projects"
 			projects1 := []string{"otherproject", "otherproject2"}
 			resp1, err := store.CreateToken(ctx, id1, description, true, projects1)

components/authz-service/engine/opa/opa_v2_internal_test.go

@@ -731,7 +731,7 @@ func BenchmarkAuthorizedProjectsIncreasingMembershipFrequency(b *testing.B) {
 	}
 }
 
-// A: more frequest membership means slower authorization times (but not by much)
+// A: more frequent membership means slower authorization times (but not by much)
 // BenchmarkAuthorizedProjectsIncreasingMembershipFrequency/store_with_0_policies_that_include_the_subject_as_a_member-8         	   179049	      8298 ns/op	    3193 B/op	      83 allocs/op
 // BenchmarkAuthorizedProjectsIncreasingMembershipFrequency/store_with_1_out_of_10_policies_that_include_the_subject_as_a_member-8   140113	     10122 ns/op	    3304 B/op	      86 allocs/op
 // BenchmarkAuthorizedProjectsIncreasingMembershipFrequency/store_with_2_out_of_10_policies_that_include_the_subject_as_a_member-8   135043	     11135 ns/op	    3304 B/op	      86 allocs/op
@@ -831,7 +831,7 @@ func v2BaselineAndRandomPoliciesAndRoles(customPolicyCount int, customRoleCount
 		}
 
 		for _, id := range customPolicyIDs {
-			// generate btwn range 1..10 statements
+			// generate between range 1..10 statements
 			// 10 is an arbitrary max
 			statementCount := rand.Intn(10-1) + 1
 
@@ -884,7 +884,7 @@ func v2BaselineAndRandomPoliciesAndRoles(customPolicyCount int, customRoleCount
 				}
 			}
 
-			// generate btwn range 1..total number of members
+			// generate between range 1..total number of members
 			memberCount := rand.Intn((len(members) - 1) + 1)
 
 			// shuffle the array of possible members,

components/automate-chef-io/Makefile

@@ -54,7 +54,9 @@ build: themes/chef generate_swagger
 	hugo
 
 # Consult scripts/spellcheck.sh in the root Automate directory for notes on using cspell.
-spellcheck:
+# This does files in automate-chef-io plus exposed proto files.
+# Alternately, you can use the common `make spell` to skip the proto files.
+spell_all:
 	@pushd ../.. > /dev/null && \
 		cspell \
 			"api/external/**/*.proto" \

components/automate-deployment/pkg/backup/builder_operations.go

@@ -227,7 +227,7 @@ func (d *BuilderMinioDumpOperation) copyObjectFromBuilder(backupCtx Context, bac
 	return writer.Close()
 }
 
-// copyObjectFromBackup copiesl data from the backup bucket to the
+// copyObjectFromBackup copies data from the backup bucket to the
 // automate-builder-minio bucket.
 func (d *BuilderMinioDumpOperation) copyObjectFromBackup(backupCtx Context, backupPrefix string, obj string, objVerifier ObjectVerifier) error {
 	ctx := backupCtx.ctx

components/automate-deployment/pkg/converge/converger.go

@@ -421,7 +421,7 @@ func (w *waitingForRestart) ProcessMessage(_ *converger, msg message) (state, bo
 
 func (w *waitingForRestart) String() string { return "waiting for restart" }
 
-// waitingForReconfigure is a converer state that we enter whenever we
+// waitingForReconfigure is a converger state that we enter whenever we
 // expect to have received a reconfiguration request from the Habitat
 // supervisor.
 type waitingForReconfigure struct {

components/automate-deployment/pkg/habpkg/semverish.go

@@ -108,7 +108,7 @@ func CompareSemverish(a SemverishVersion, b SemverishVersion) int {
 		return SemverishLess
 	}
 
-	// Otherwise, just lexigraphically sort the pre-release, this
+	// Otherwise, just lexicographically sort the pre-release, this
 	// is not what the spec says to do.
 	if a.prerelease < b.prerelease {
 		return SemverishLess

components/automate-deployment/pkg/habpkg/semverish_test.go

@@ -106,14 +106,14 @@ func TestSemverCompare(t *testing.T) {
 	}
 }
 
-func BenchmarkParseSemverishVerionBasic(b *testing.B) {
+func BenchmarkParseSemverishVersionBasic(b *testing.B) {
 	v := "1.2.3"
 	for n := 0; n < b.N; n++ {
 		ParseSemverishVersion(v)
 	}
 }
 
-func BenchmarkParseSemverishVerionAll(b *testing.B) {
+func BenchmarkParseSemverishVersionAll(b *testing.B) {
 	l := len(semverTests)
 	for n := 0; n < b.N; n++ {
 		ParseSemverishVersion(semverTests[n%l].input)

components/automate-deployment/pkg/manifest/client/http.go

@@ -62,7 +62,7 @@ var packagesChefIOKeyRing openpgp.EntityList
 func init() {
 	entityList, err := openpgp.ReadArmoredKeyRing(strings.NewReader(packagesChefIOSigAsc))
 	if err != nil {
-		panic(errors.Wrap(err, "Failed to read pacakges.chef.io public key"))
+		panic(errors.Wrap(err, "Failed to read packages.chef.io public key"))
 	}
 	packagesChefIOKeyRing = entityList
 }

components/automate-deployment/pkg/server/startup_helpers.go

@@ -39,7 +39,7 @@ func habSupVersion() string {
 }
 
 // maybeResetHabPath adds the bindir from our manifest's hab package
-// to our PATH. This is a developent-mode only operation to account
+// to our PATH. This is a development-mode only operation to account
 // for test cases where we want to deploy with the latest Habitat.
 func maybeResetHabPath(s *server) {
 	if os.Getenv("CHEF_DEV_ENVIRONMENT") != "true" {

components/automate-deployment/pkg/target/local_target.go

@@ -743,7 +743,7 @@ func (t *LocalTarget) HabSupRestart(ctx context.Context, sortedServiceList []str
 // shuts down services with a TERM followed (after 8 seconds) by a
 // KILL. We would like to avoid the KILL being sent to our data
 // services. Shutting down services in their reverse startup order
-// makes it more liely that data services will shut down quickly since
+// makes it more likely that data services will shut down quickly since
 // all of their clients have been stopped.
 func (t *LocalTarget) SystemdRestart(ctx context.Context, sortedServiceList []string) (bool, error) {
 	habSupP, err := t.habSup.SupPkg()

components/automate-gateway/gateway/server.go

@@ -421,7 +421,7 @@ func (s *Server) Serve() error {
 	// `rpc Export(Query) returns (stream ExportData) {};`
 	mux.HandleFunc("/compliance/reporting/export", s.ReportExportHandler)
 
-	// custome mux route for export of all reports for a single node
+	// custom mux route for export of all reports for a single node
 	mux.HandleFunc("/compliance/reporting/node/export", s.NodeExportHandler)
 
 	// custom mux route for export (ignores its request method)

components/automate-gateway/integration/data_lifecycle_test.go

@@ -197,7 +197,7 @@ func (suite *GatewayTestSuite) TestDataLifecycleConfigure() {
 }
 
 // TestDataLifecycleRun ensures that when "run" is called that we actually run
-// data lifecycle jobs on the backend. Each invidual service already has
+// data lifecycle jobs on the backend. Each individual service already has
 // integrations tests for their data lifecycle jobs so we only need to test
 // if the jobs are being triggered successfully. The purge jobs record their
 // start and end times in the database so we can use the timestamps to determine

components/automate-openjdk/habitat/plan.sh

@@ -2,7 +2,7 @@
 #shellcheck disable=SC2154
 
 # Instead of wrapping the core/openjdk11 package, we're using our own so that
-# we don't need to depend on ALSA or FreeType, which have non-comaptible licenses.
+# we don't need to depend on ALSA or FreeType, which have non-compatible licenses.
 
 pkg_origin=chef
 pkg_maintainer="Chef Software Inc. <[email protected]>"

components/automate-ui/docs/css_scss_and_styling.md

@@ -12,7 +12,7 @@
   * [Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Using_CSS_flexible_boxes)
   * Small sample of reusable components currently available in the `/component` library
 
-## CSS dont
+## CSS don't
 
 * `!important`s should NOT be used
 * comments disabling the linter should and will be reviewed with extreme skepticism

components/automate-ui/src/app/entities/layout/layout-sidebar.service.ts

@@ -71,7 +71,7 @@ export class LayoutSidebarService {
         }];
     }
 
-    public getInfastructureSidebar(): MenuItemGroup[] {
+    public getInfrastructureSidebar(): MenuItemGroup[] {
         return [{
             name: 'Infrastructure',
             items: [

components/automate-ui/src/app/entities/layout/layout.facade.ts

@@ -82,9 +82,9 @@ export class LayoutFacadeService {
     ));
   }
 
-  showInfastructureSidebar(): void {
+  showInfrastructureSidebar(): void {
     this.store.dispatch(new UpdateSidebarMenuGroups(
-      this.layoutSidebarService.getInfastructureSidebar()
+      this.layoutSidebarService.getInfrastructureSidebar()
     ));
   }
 

components/automate-ui/src/app/page-components/search-bar/search-bar.component.spec.ts

@@ -392,7 +392,7 @@ describe('SearchBarComponent', () => {
           component.handleInput('enter', 'chef-?-nodes');
         });
 
-        it('catagory does not allow wildcards', () => {
+        it('category does not allow wildcards', () => {
           jasmine.clock().uninstall();
           jasmine.clock().install();
           component.selectedCategoryType = component.categories[0];

components/automate-ui/src/app/pages/+compliance/+reporting/+reporting-overview/reporting-overview.component.spec.ts

@@ -78,7 +78,7 @@ describe('ReportingOverviewComponent', () => {
       spyOn(router, 'navigate');
       spyOn(console, 'warn');
 
-      component.onDateChanged('lkjasdl');
+      component.onDateChanged('not-a-date');
 
       expect(router.navigate).not.toHaveBeenCalled();
     });

components/automate-ui/src/app/pages/+compliance/+reporting/reporting.component.spec.ts

@@ -382,7 +382,7 @@ describe('ReportingComponent', () => {
       );
     });
 
-    it('parse invaild interval 1', () => {
+    it('parse invalid interval 1', () => {
       spyOn(reportQueryService, 'setState');
       const endDate = moment().utc().startOf('day').add(12, 'hours');
       const interval = 0;
@@ -405,7 +405,7 @@ describe('ReportingComponent', () => {
       );
     });
 
-    it('parse invaild interval 2', () => {
+    it('parse invalid interval 2', () => {
       spyOn(reportQueryService, 'setState');
       const endDate = moment().utc().startOf('day').add(12, 'hours');
       const interval = 0;

components/automate-ui/src/app/pages/client-runs/client-runs.component.ts

@@ -252,7 +252,7 @@ export class ClientRunsComponent implements OnInit, OnDestroy {
   ) { }
 
   ngOnInit() {
-    this.layoutFacade.showInfastructureSidebar();
+    this.layoutFacade.showInfrastructureSidebar();
     // Only load when first opening the /chef-runs page
     this.store.dispatch(new GetWorkflowEnabled());
 

components/automate-ui/src/app/pages/data-feed/data-feed.component.html

@@ -11,10 +11,10 @@
       </chef-page-header>
 
       <div class="page-body">
-        <chef-alert type="error" *ngIf="errorLoading">There was an error loading destiantions.</chef-alert>
-      
+        <chef-alert type="error" *ngIf="errorLoading">There was an error loading destinations.</chef-alert>
+
         <chef-toolbar>
-        
+
         <app-authorized [anyOf]="['/datafeed/destination', 'post']">
           <div *ngIf="(destinations$ | async)?.length === 0" class="empty-state">
             <p>Create the first datafeed endpoint to get started!</p>
@@ -23,9 +23,9 @@
             <chef-button primary [routerLink]="['/settings/data-feed/form']">Create Destination</chef-button>
           </div>
         </app-authorized>
-        
+
         </chef-toolbar>
-        
+
         <app-authorized [anyOf]="['/datafeed/destinations', 'post']">
           <chef-table *ngIf="(destinations$ | async)?.length > 0" id="destinations-list">
             <chef-tr>
@@ -48,18 +48,18 @@
               </chef-td>
             </chef-tr>
           </chef-table>
-        
+
         </app-authorized>
-      
-      
+
+
         <app-page-picker
           [total]="(destinations$ | async)?.length"
           [perPage]="pageSize"
           [page]="currentPage"
           (pageChanged)="currentPage = $event">
         </app-page-picker>
-      
+
       </div><!--page-body-->
     </main>
   </div><!--destinations-container-->
-</div>
+</div>

components/automate-ui/src/app/pages/node-details/node-details.component.ts

@@ -38,7 +38,7 @@ export class NodeDetailsComponent implements OnInit, OnDestroy {
   }
 
   ngOnInit() {
-    this.layoutFacade.showInfastructureSidebar();
+    this.layoutFacade.showInfrastructureSidebar();
     // Scroll to the top of the view
     window.scrollTo(0, 0);
     this.nodeId = this.getRouteParam('node-id');

components/automate-ui/src/app/pages/node-noruns-details/node-noruns-details.component.ts

@@ -20,7 +20,7 @@ export class NodeNoRunsDetailsComponent implements OnInit {
   ) {}
 
   ngOnInit() {
-    this.layoutFacade.showInfastructureSidebar();
+    this.layoutFacade.showInfrastructureSidebar();
     this.nodeId = this.getRouteParam('node-id');
     this.route.data.subscribe((data: { node: Node }) => {
         this.node = data.node;

components/automate-ui/src/app/pages/service-groups/service-groups.component.ts

@@ -46,7 +46,7 @@ export class ServiceGroupsComponent implements OnInit, OnDestroy {
   public serviceGroupsError$: Observable<HttpErrorResponse>;
   public sgHealthSummary: ServiceGroupsHealthSummary;
 
-  // Selected sarch bar filters
+  // Selected search bar filters
   public selectedSearchBarFilters = [];
 
   // The selected service-group id that will be sent to the services-sidebar
@@ -244,7 +244,7 @@ export class ServiceGroupsComponent implements OnInit, OnDestroy {
     // selected service group. However, this logic does not apply to the
     // *service* status filters (in the services sidebar); when all services
     // are filtered out via those status filters we have a special state that
-    // says, e.g., "none of the services reuturned warning" that we want to
+    // says, e.g., "none of the services returned warning" that we want to
     // show.
     this.store.select(serviceGroupsStatus).subscribe((sgStatus) => {
       if (sgStatus === 'loadingSuccess') {

components/automate-workflow-ctl/lib/ctl-helpers/ohai.rb

@@ -23,7 +23,7 @@ def self.ohai
     # Simplifies resetting the cached ohai for testing purposes.
     def self.reset!
       remove_class_variable(:@@ohai) if class_variable_defined?(:@@ohai)
-      # Dont' return the value of old @@ohai
+      # Don't return the value of old @@ohai
       nil
     end
   end

components/compliance-service/api/reporting/server/server.go

@@ -163,7 +163,7 @@ func (srv *Server) ListProfiles(ctx context.Context, in *reporting.Query) (*repo
 	return &profileMins, nil
 }
 
-// ListControlItems returns a list of contolListItems based on query
+// ListControlItems returns a list of controlListItems based on query
 func (srv *Server) ListControlItems(ctx context.Context, in *reporting.ControlItemRequest) (*reporting.ControlItems, error) {
 	var controlListItems *reporting.ControlItems
 	if in.Size == 0 {

components/compliance-service/compliance.go

@@ -402,7 +402,7 @@ func setupDataLifecyclePurgeInterface(ctx context.Context, connFactory *secureco
 
 	// Migrate default policy values from the config. The default policies are
 	// only persisted the first time the workflow is created, after which only
-	// new default policies are added and/or existing policies indicies are
+	// new default policies are added and/or existing policies indices are
 	// updated in case they have been migrated.
 
 	for i, p := range defaultPurgePolicies.Es {

components/compliance-service/scanner/db.go

@@ -285,7 +285,7 @@ func (s *Scanner) UpdateParentJobSchedule(jobId string, jobCount int32, recurren
 	// Parsing the recurrence RRULE
 	r, err := rrule.StrToRRule(recurrence)
 	if err != nil {
-		return errors.Wrapf(err, "UpdateParentJobSchedule unablee to parse recurrence string")
+		return errors.Wrapf(err, "UpdateParentJobSchedule unable to parse recurrence string")
 	}
 
 	nowTimeUtc := time.Now().UTC()

components/data-feed-service/service/data-feed-poll-task.go

@@ -150,7 +150,7 @@ func (d *DataFeedPollTask) getFeedEndTime(feedInterval time.Duration, now time.T
 	return feedEndTime
 }
 
-// GetChangedNodes calls the nodes API to get any nodes whch have had a client run during the interval
+// GetChangedNodes calls the nodes API to get any nodes which have had a client run during the interval
 // Returns a map of ipaddress to NodeIDs struct
 func (d *DataFeedPollTask) GetChangedNodes(ctx context.Context, pageSize int32, feedStartTime time.Time, feedEndTime time.Time) (map[string]NodeIDs, error) {
 	log.Debugf("Inventory nodes start %v, %v, %v", pageSize, feedStartTime, feedEndTime)