Reorganize go imports to be more consistent

.pre-commit-config.yaml

@@ -56,6 +56,20 @@ repos:
       - id: golangci-lint
         entry: bash -c 'exec golangci-lint run ${GOLANGCI_LINT_VERBOSE} -j=${GOLANGCI_LINT_CONCURRENCY:-1}' # custom bash so we can override concurrency for faster dev runs
 
+  # We use `gci` here to make go imports consistent. This tool is also available in golangci-lint, but it
+  # is not particularly useful there currently due to these two issues:
+  #   - https://github.com/golangci/golangci-lint/issues/2604
+  #   - https://github.com/daixiang0/gci/issues/59
+  # We should revisit later and if these issues are fixed, consider using gci inside of golangci-lint.
+  - repo: local
+    hooks:
+      - id: fix-go-imports
+        name: fix go imports
+        entry: scripts/fix-go-imports
+        files: ^cmd/.*\.go$|^pkg/.*\.go$
+        exclude: ^pkg/gen/|^pkg/assets/|/*mocks/
+        language: script
+
   - repo: local
     hooks:
       - id: ato-go-linter

Makefile

@@ -221,6 +221,10 @@ bin/gotestsum: .check_go_version.stamp .check_gopath.stamp pkg/tools/tools.go
 bin/mockery: .check_go_version.stamp .check_gopath.stamp pkg/tools/tools.go
 	go build -o bin/mockery github.com/vektra/mockery/v2
 
+# No static linking / $(LDFLAGS) because gci is only used for making go imports consistent
+bin/gci: .check_go_version.stamp .check_gopath.stamp pkg/tools/tools.go
+	go build -o bin/gci github.com/daixiang0/gci
+
 ### Cert Targets
 # AWS is only providing a bundle for the 2022 cert, which includes 2017? and rds-ca-rsa4096-g1
 bin/rds-ca-rsa4096-g1.pem:
@@ -366,6 +370,7 @@ build_tools: bin/gin \
 	bin/big-cat \
 	bin/generate-deploy-notes \
 	bin/ecs-deploy \
+	bin/gci \
 	bin/generate-payment-request-edi \
 	bin/generate-shipment-summary \
 	bin/generate-test-data \
@@ -1185,6 +1190,7 @@ reviewapp_docker_destroy:
 .PHONY: telemetry_docker
 telemetry_docker:
 	docker-compose -f docker-compose.telemetry.yml up
+
 #
 # ----- END RANDOM TARGETS -----
 #

cmd/generate-shipment-summary/main.go

@@ -8,23 +8,20 @@ import (
 	"strings"
 	"time"
 
+	"github.com/gofrs/uuid"
 	"github.com/pkg/errors"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
 
 	"github.com/transcom/mymove/pkg/appcontext"
+	"github.com/transcom/mymove/pkg/auth"
 	"github.com/transcom/mymove/pkg/cli"
 	"github.com/transcom/mymove/pkg/logging"
-	"github.com/transcom/mymove/pkg/rateengine"
-	"github.com/transcom/mymove/pkg/route"
-
-	"github.com/transcom/mymove/pkg/auth"
-
-	"github.com/gofrs/uuid"
-
 	"github.com/transcom/mymove/pkg/models"
 	"github.com/transcom/mymove/pkg/paperwork"
+	"github.com/transcom/mymove/pkg/rateengine"
+	"github.com/transcom/mymove/pkg/route"
 )
 
 // hereRequestTimeout is how long to wait on HERE request before timing out (15 seconds).

cmd/ghc-pricing-parser/main.go

@@ -14,9 +14,8 @@ import (
 	"github.com/pterm/pterm/putils"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
-	"go.uber.org/zap"
-
 	"github.com/tealeg/xlsx/v3"
+	"go.uber.org/zap"
 
 	"github.com/transcom/mymove/pkg/appcontext"
 	"github.com/transcom/mymove/pkg/cli"

cmd/ghc-transit-time-parser/main.go

@@ -9,9 +9,8 @@ import (
 
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
-	"go.uber.org/zap"
-
 	"github.com/tealeg/xlsx/v3"
+	"go.uber.org/zap"
 
 	"github.com/transcom/mymove/pkg/appcontext"
 	"github.com/transcom/mymove/pkg/cli"

cmd/milmove-tasks/post_file_to_gex.go

@@ -9,7 +9,6 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
-
 	"go.uber.org/zap"
 
 	"github.com/transcom/mymove/pkg/certs"

cmd/milmove-tasks/process_edis.go

@@ -8,9 +8,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/transcom/mymove/pkg/appcontext"
-	"github.com/transcom/mymove/pkg/certs"
-
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/credentials"
 	"github.com/aws/aws-sdk-go/aws/credentials/stscreds"
@@ -21,6 +18,8 @@ import (
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
 
+	"github.com/transcom/mymove/pkg/appcontext"
+	"github.com/transcom/mymove/pkg/certs"
 	"github.com/transcom/mymove/pkg/cli"
 	"github.com/transcom/mymove/pkg/db/sequence"
 	ediinvoice "github.com/transcom/mymove/pkg/edi/invoice"

cmd/milmove-tasks/send_payment_reminder_email.go

@@ -5,13 +5,12 @@ import (
 	"log"
 	"strings"
 
-	"github.com/spf13/cobra"
-
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/credentials"
 	"github.com/aws/aws-sdk-go/aws/credentials/stscreds"
 	awssession "github.com/aws/aws-sdk-go/aws/session"
 	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"

cmd/milmove-tasks/send_post_move_survey_email.go

@@ -6,13 +6,12 @@ import (
 	"strings"
 	"time"
 
-	"github.com/spf13/cobra"
-
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/credentials"
 	"github.com/aws/aws-sdk-go/aws/credentials/stscreds"
 	awssession "github.com/aws/aws-sdk-go/aws/session"
 	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"go.uber.org/zap"

cmd/prime-api-client/prime/create_mto_service_item.go

@@ -15,7 +15,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoServiceItem "github.com/transcom/mymove/pkg/gen/primeclient/mto_service_item"
 	"github.com/transcom/mymove/pkg/gen/primemessages"
 )

cmd/prime-api-client/prime/create_mto_shipment.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoShipment "github.com/transcom/mymove/pkg/gen/primeclient/mto_shipment"
 )
 

cmd/prime-api-client/prime/get_move_task_order.go

@@ -9,13 +9,11 @@ import (
 	"time"
 
 	"github.com/gofrs/uuid"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mto "github.com/transcom/mymove/pkg/gen/primeclient/move_task_order"
 )
 

cmd/prime-api-client/prime/list_moves.go

@@ -8,13 +8,11 @@ import (
 	"time"
 
 	"github.com/go-openapi/strfmt"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mto "github.com/transcom/mymove/pkg/gen/primeclient/move_task_order"
 	"github.com/transcom/mymove/pkg/gen/primemessages"
 )

cmd/prime-api-client/prime/update_mto_shipment.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoShipment "github.com/transcom/mymove/pkg/gen/primeclient/mto_shipment"
 )
 

cmd/prime-api-client/prime/update_mto_shipment_address.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoShipment "github.com/transcom/mymove/pkg/gen/primeclient/mto_shipment"
 )
 

cmd/prime-api-client/prime/update_mto_shipment_status.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoShipment "github.com/transcom/mymove/pkg/gen/primeclient/mto_shipment"
 )
 

cmd/prime-api-client/support/create_move_task_order.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	movetaskorderclient "github.com/transcom/mymove/pkg/gen/supportclient/move_task_order"
 )
 

cmd/prime-api-client/support/create_webhook_notification.go

@@ -12,7 +12,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	webhookclient "github.com/transcom/mymove/pkg/gen/supportclient/webhook"
 )
 

cmd/prime-api-client/support/get_move_task_order.go

@@ -9,13 +9,11 @@ import (
 	"time"
 
 	"github.com/gofrs/uuid"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mto "github.com/transcom/mymove/pkg/gen/supportclient/move_task_order"
 )
 

cmd/prime-api-client/support/list_mto_payment_requests.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	paymentrequestclient "github.com/transcom/mymove/pkg/gen/supportclient/payment_request"
 )
 

cmd/prime-api-client/support/list_mtos.go

@@ -12,7 +12,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mto "github.com/transcom/mymove/pkg/gen/supportclient/move_task_order"
 )
 

cmd/prime-api-client/support/make_move_task_order_available.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mto "github.com/transcom/mymove/pkg/gen/supportclient/move_task_order"
 )
 

cmd/prime-api-client/support/recalculate_payment_request.go

@@ -10,14 +10,12 @@ import (
 
 	"github.com/go-openapi/strfmt"
 	"github.com/gofrs/uuid"
-
-	paymentrequestclient "github.com/transcom/mymove/pkg/gen/supportclient/payment_request"
-
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
+	paymentrequestclient "github.com/transcom/mymove/pkg/gen/supportclient/payment_request"
 )
 
 // InitRecalculatePaymentRequestFlags declares which flags are enabled

cmd/prime-api-client/support/update_mto_service_item_status.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoserviceitem "github.com/transcom/mymove/pkg/gen/supportclient/mto_service_item"
 )
 

cmd/prime-api-client/support/update_mto_shipment_status.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	mtoShipment "github.com/transcom/mymove/pkg/gen/supportclient/mto_shipment"
 )
 

cmd/prime-api-client/support/update_payment_request_status.go

@@ -13,7 +13,6 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/transcom/mymove/cmd/prime-api-client/utils"
-
 	paymentrequestclient "github.com/transcom/mymove/pkg/gen/supportclient/payment_request"
 )
 

cmd/webhook-client/command_test.go

@@ -4,14 +4,12 @@ import (
 	"bytes"
 	"testing"
 
+	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/suite"
 	"go.uber.org/zap"
 
-	"github.com/transcom/mymove/pkg/testingsuite"
-
-	"github.com/spf13/cobra"
-
 	"github.com/transcom/mymove/pkg/logging"
+	"github.com/transcom/mymove/pkg/testingsuite"
 )
 
 // WebhookClientTestingSuite is a suite for testing the webhook client

cmd/webhook-client/webhook_notify.go

@@ -8,12 +8,11 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
+	"go.uber.org/zap"
 
 	"github.com/transcom/mymove/cmd/webhook-client/utils"
 	"github.com/transcom/mymove/cmd/webhook-client/webhook"
 	"github.com/transcom/mymove/pkg/appcontext"
-
-	"go.uber.org/zap"
 )
 
 const (

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/aws/aws-sdk-go v1.44.13
 	github.com/benbjohnson/clock v1.3.0
 	github.com/codegangsta/gin v0.0.0-20171026143024-cafe2ce98974
+	github.com/daixiang0/gci v0.3.3
 	github.com/disintegration/imaging v1.6.2
 	github.com/dustin/go-humanize v1.0.0
 	github.com/felixge/httpsnoop v1.0.3
@@ -130,6 +131,7 @@ require (
 	github.com/gorilla/securecookie v1.1.1 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/hexops/gotextdiff v1.0.3 // indirect
 	github.com/hhrutter/lzw v0.0.0-20190827003112-58b82c5a41cc // indirect
 	github.com/hhrutter/tiff v0.0.0-20190827003322-d08e2ad45835 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect

go.sum

@@ -143,6 +143,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsr
 github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/daixiang0/gci v0.3.3 h1:55xJKH7Gl9Vk6oQ1cMkwrDWjAkT1D+D1G9kNmRcAIY4=
+github.com/daixiang0/gci v0.3.3/go.mod h1:1Xr2bxnQbDxCqqulUOv8qpGqkgRw9RSCGGjEC2LjF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -471,6 +473,8 @@ github.com/hashicorp/memberlist v0.3.0/go.mod h1:MS2lj3INKhZjWNqd3N0m3J+Jxf3DAOn
 github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc=
 github.com/hashicorp/serf v0.9.5/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk=
 github.com/hashicorp/serf v0.9.6/go.mod h1:TXZNMjZQijwlDvp+r0b63xZ45H7JmCmgg4gpTwn9UV4=
+github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
+github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
 github.com/hhrutter/lzw v0.0.0-20190827003112-58b82c5a41cc h1:crd+cScoxEqSOqClzjkNMNQNdMCF3SGXhPdDWBQfNZE=
 github.com/hhrutter/lzw v0.0.0-20190827003112-58b82c5a41cc/go.mod h1:yJBvOcu1wLQ9q9XZmfiPfur+3dQJuIhYQsMGLYcItZk=
 github.com/hhrutter/tiff v0.0.0-20190827003322-d08e2ad45835 h1:8XqemC6WorzU92LW/+cMr8e+oCpRUobYuieBCpb7bLw=