Merge pull request #1718 from moov-io/feat-fix-cmd

cmd/achcli: add -fix command

Author: adamdecaf

.gitignore

@@ -64,3 +64,5 @@ openapi-generator*.jar
 /client/
 .idea/
 .vscode/
+
+test/testdata/ppd-debit.ach.fix

cmd/achcli/fix/config.go

@@ -0,0 +1,5 @@
+package fix
+
+type Config struct {
+	UpdateEED string
+}

cmd/achcli/fix/fix.go

@@ -0,0 +1,54 @@
+package fix
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+
+	"github.com/moov-io/ach"
+	"github.com/moov-io/ach/cmd/achcli/internal/read"
+	"github.com/moov-io/ach/cmd/achcli/internal/write"
+)
+
+func Perform(path string, validateOptsPath *string, skipAll *bool, conf Config) (string, error) {
+	file, format, err := read.Filepath(path, validateOptsPath, skipAll)
+	if err != nil {
+		return "", fmt.Errorf("reading %s failed: %w", path, err)
+	}
+
+	// Build up our fixers
+	var batchHeaderFixers []batchHeaderFixer
+	if conf.UpdateEED != "" {
+		batchHeaderFixers = append(batchHeaderFixers, updateEED(conf))
+	}
+
+	// Fix the file
+	for idx := range file.Batches {
+		// Batch headers
+		bh := file.Batches[idx].GetHeader()
+		for _, fn := range batchHeaderFixers {
+			if err := fn(bh); err != nil {
+				return "", fmt.Errorf("applying %T to batch header: %w", fn, err)
+			}
+		}
+		file.Batches[idx].SetHeader(bh)
+	}
+
+	// Write file
+	newpath := path + ".fix"
+
+	var buf bytes.Buffer
+	err = write.File(&buf, file, format)
+	if err != nil {
+		return "", fmt.Errorf("encoding fixed file as %s: %w", format, err)
+	}
+
+	err = os.WriteFile(newpath, buf.Bytes(), 0600)
+	if err != nil {
+		return "", fmt.Errorf("writing %s failed: %w", newpath, err)
+	}
+
+	return newpath, nil
+}
+
+type batchHeaderFixer func(bh *ach.BatchHeader) error

cmd/achcli/fix/fix_test.go

@@ -0,0 +1,55 @@
+package fix_test
+
+import (
+	"bytes"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/moov-io/ach/cmd/achcli/fix"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestPerform(t *testing.T) {
+	cases := []struct {
+		inputFilepath    string
+		validateOptsPath *string
+		skipAll          *bool
+		config           fix.Config
+		expectedFilepath string
+	}{
+		{
+			inputFilepath: filepath.Join("..", "..", "..", "test", "testdata", "ppd-debit.ach"),
+			config: fix.Config{
+				UpdateEED: "20251224",
+			},
+			expectedFilepath: filepath.Join("..", "..", "..", "test", "testdata", "ppd-debit.ach.fix.expected"),
+		},
+	}
+	for _, tc := range cases {
+		_, filename := filepath.Split(tc.inputFilepath)
+
+		t.Run(filename, func(t *testing.T) {
+			newpath, err := fix.Perform(tc.inputFilepath, tc.validateOptsPath, tc.skipAll, tc.config)
+			require.NoError(t, err)
+
+			got, err := os.ReadFile(newpath)
+			require.NoError(t, err)
+
+			expected, err := os.ReadFile(tc.expectedFilepath)
+			require.NoError(t, err)
+
+			got = normalize(got)
+			expected = normalize(expected)
+
+			require.Equal(t, string(expected), string(got))
+		})
+	}
+}
+
+func ptr[T any](in T) *T { return &in }
+
+func normalize(input []byte) []byte {
+	return bytes.TrimSpace(bytes.ReplaceAll(input, []byte("\r\n"), []byte("\n")))
+}

cmd/achcli/fix/fixers.go

@@ -0,0 +1,12 @@
+package fix
+
+import (
+	"github.com/moov-io/ach"
+)
+
+func updateEED(conf Config) batchHeaderFixer {
+	return func(bh *ach.BatchHeader) error {
+		bh.EffectiveEntryDate = conf.UpdateEED
+		return nil
+	}
+}

cmd/achcli/internal/read/read.go

@@ -0,0 +1,75 @@
+package read
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/moov-io/ach"
+)
+
+type Format string
+
+var (
+	FormatUnknown Format = "unknown"
+	FormatNacha   Format = "nacha"
+	FormatJSON    Format = "json"
+)
+
+func Filepath(path string, validateOptsPath *string, skipAll *bool) (*ach.File, Format, error) {
+	validateOpts, err := readValidationOpts(validateOptsPath, skipAll)
+	if err != nil {
+		return nil, FormatUnknown, err
+	}
+	return readFile(path, validateOpts)
+}
+
+func readValidationOpts(path *string, skipAll *bool) (*ach.ValidateOpts, error) {
+	var opts ach.ValidateOpts
+
+	if skipAll != nil && *skipAll {
+		opts.SkipAll = true
+		return &opts, nil
+	}
+
+	if path != nil && *path != "" {
+		// read config file
+		bs, readErr := os.ReadFile(*path)
+		if readErr != nil {
+			return nil, fmt.Errorf("reading %s for validate opts failed: %w", *path, readErr)
+		}
+
+		if err := json.Unmarshal(bs, &opts); err != nil {
+			return nil, fmt.Errorf("unmarshal of validate opts failed: %v", err)
+		}
+		return &opts, nil
+	}
+
+	return nil, nil
+}
+
+func readFile(path string, validateOpts *ach.ValidateOpts) (*ach.File, Format, error) {
+	bs, err := os.ReadFile(path)
+	if err != nil {
+		return nil, FormatUnknown, err
+	}
+	if json.Valid(bs) {
+		return readJsonFile(bs, validateOpts)
+	}
+	return readACHFile(bs, validateOpts)
+}
+
+func readACHFile(input []byte, validateOpts *ach.ValidateOpts) (*ach.File, Format, error) {
+	r := ach.NewReader(bytes.NewReader(input))
+	r.SetValidation(validateOpts)
+
+	f, err := r.Read()
+
+	return &f, FormatNacha, err
+}
+
+func readJsonFile(input []byte, validateOpts *ach.ValidateOpts) (*ach.File, Format, error) {
+	file, err := ach.FileFromJSONWith(input, validateOpts)
+	return file, FormatJSON, err
+}

cmd/achcli/internal/read/read_test.go

@@ -0,0 +1,42 @@
+package read_test
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/moov-io/ach/cmd/achcli/internal/read"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRead(t *testing.T) {
+	cases := []struct {
+		inputFilepath    string
+		validateOptsPath *string
+		skipAll          *bool
+
+		expectedFormat read.Format
+	}{
+		{
+			inputFilepath:    filepath.Join("..", "..", "..", "..", "test", "testdata", "ppd-debit-invalid-entryDetail-checkDigit.ach"),
+			validateOptsPath: ptr(filepath.Join("..", "..", "..", "..", "test", "testdata", "ppd-debit-invalid-entryDetail-checkDigit.json")),
+			expectedFormat:   read.FormatNacha,
+		},
+		{
+			inputFilepath:  filepath.Join("..", "..", "..", "..", "test", "testdata", "ppd-valid-preserve-spaces.json"),
+			expectedFormat: read.FormatJSON,
+		},
+	}
+	for _, tc := range cases {
+		_, filename := filepath.Split(tc.inputFilepath)
+
+		t.Run(filename, func(t *testing.T) {
+			file, format, err := read.Filepath(tc.inputFilepath, tc.validateOptsPath, tc.skipAll)
+			require.NoError(t, err)
+			require.Equal(t, tc.expectedFormat, format)
+			require.NotNil(t, file)
+		})
+	}
+}
+
+func ptr[T any](in T) *T { return &in }

cmd/achcli/internal/write/write.go

@@ -0,0 +1,20 @@
+package write
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+
+	"github.com/moov-io/ach"
+	"github.com/moov-io/ach/cmd/achcli/internal/read"
+)
+
+func File(w io.Writer, file *ach.File, format read.Format) error {
+	switch format {
+	case read.FormatNacha:
+		return ach.NewWriter(w).Write(file)
+	case read.FormatJSON:
+		return json.NewEncoder(w).Encode(file)
+	}
+	return fmt.Errorf("unknown format %v", format)
+}

cmd/achcli/main.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 
 	"github.com/moov-io/ach"
+	"github.com/moov-io/ach/cmd/achcli/fix"
 )
 
 var (
@@ -33,6 +34,10 @@ var (
 
 	flagSkipValidation = flag.Bool("skip-validation", false, "Skip all validation checks")
 	flagValidateOpts   = flag.String("validate", "", "Path to config file in json format to enable validation opts")
+
+	// Fix commands
+	flagFix       = flag.Bool("fix", false, "Trigger fix tasks")
+	flagUpdateEED = flag.String("update-eed", "", "Set the EffectiveEntryDate to a new value")
 )
 
 func main() {
@@ -78,6 +83,21 @@ func main() {
 			os.Exit(1)
 		}
 
+	case *flagFix:
+		if len(args) != 1 {
+			fmt.Printf("ERROR: unexpected %d arguments: %#v\n", len(args), args)
+			os.Exit(1)
+		}
+		conf := fix.Config{
+			UpdateEED: *flagUpdateEED,
+		}
+		newpath, err := fix.Perform(args[0], flagValidateOpts, flagSkipValidation, conf)
+		if err != nil {
+			fmt.Printf("ERROR: %v\n", err)
+			os.Exit(1)
+		}
+		fmt.Printf("Fixed file: %s\n", newpath)
+
 	case *flagReformat != "" && len(args) == 1:
 		if err := reformat(*flagReformat, args[0], validateOpts); err != nil {
 			fmt.Printf("ERROR: %v\n", err)

test/testdata/ppd-debit-invalid-entryDetail-checkDigit.json

@@ -0,0 +1 @@
+{"allowInvalidCheckDigit": true}