addenda13_test.go

// Licensed to The Moov Authors under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. The Moov Authors licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package ach

import (
	"testing"

	"github.com/moov-io/base"
)

// mockAddenda13 creates a mock Addenda13 record
func mockAddenda13() *Addenda13 {
	addenda13 := NewAddenda13()
	addenda13.ODFIName = "Wells Fargo"
	addenda13.ODFIIDNumberQualifier = "01"
	addenda13.ODFIIdentification = "121042882"
	addenda13.ODFIBranchCountryCode = "US"
	addenda13.EntryDetailSequenceNumber = 00000001
	return addenda13
}

// testAddenda13Parse parses Addenda13 record
func testAddenda13Parse(t testing.TB) {
	Addenda13 := NewAddenda13()
	line := "713Wells Fargo                        01121042882                         US           0000001"
	Addenda13.Parse(line)
	// walk the Addenda13 struct
	if Addenda13.TypeCode != "13" {
		t.Errorf("expected %v got %v", "13", Addenda13.TypeCode)
	}
	if Addenda13.ODFIName != "Wells Fargo" {
		t.Errorf("expected %v got %v", "Wells Fargo", Addenda13.ODFIName)
	}
	if Addenda13.ODFIIDNumberQualifier != "01" {
		t.Errorf("expected: %v got: %v", "01", Addenda13.ODFIIDNumberQualifier)
	}
	if Addenda13.ODFIIdentification != "121042882" {
		t.Errorf("expected: %v got: %v", "121042882", Addenda13.ODFIIdentification)
	}
	if Addenda13.ODFIBranchCountryCode != "US" {
		t.Errorf("expected: %s got: %s", "US", Addenda13.ODFIBranchCountryCode)
	}
	if Addenda13.EntryDetailSequenceNumber != 0000001 {
		t.Errorf("expected: %v got: %v", 0000001, Addenda13.EntryDetailSequenceNumber)
	}
}

// TestAddenda13Parse tests parsing Addenda13 record
func TestAddenda13Parse(t *testing.T) {
	testAddenda13Parse(t)
}

// BenchmarkAddenda13Parse benchmarks parsing Addenda13 record
func BenchmarkAddenda13Parse(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13Parse(b)
	}
}

// TestMockAddenda13 validates mockAddenda13
func TestMockAddenda13(t *testing.T) {
	addenda13 := mockAddenda13()
	if err := addenda13.Validate(); err != nil {
		t.Error("mockAddenda13 does not validate and will break other tests")
	}
}

// testAddenda13ValidTypeCode validates Addenda13 TypeCode
func testAddenda13ValidTypeCode(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.TypeCode = "65"
	err := addenda13.Validate()
	if !base.Match(err, ErrAddendaTypeCode) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13ValidTypeCode tests validating Addenda13 TypeCode
func TestAddenda13ValidTypeCode(t *testing.T) {
	testAddenda13ValidTypeCode(t)
}

// BenchmarkAddenda13ValidTypeCode benchmarks validating Addenda13 TypeCode
func BenchmarkAddenda13ValidTypeCode(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13ValidTypeCode(b)
	}
}

// testAddenda13TypeCode13 TypeCode is 13 if TypeCode is a valid TypeCode
func testAddenda13TypeCode13(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.TypeCode = "05"
	err := addenda13.Validate()
	if !base.Match(err, ErrAddendaTypeCode) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13TypeCode13 tests TypeCode is 13 if TypeCode is a valid TypeCode
func TestAddenda13TypeCode13(t *testing.T) {
	testAddenda13TypeCode13(t)
}

// BenchmarkAddenda13TypeCode13 benchmarks TypeCode is 13 if TypeCode is a valid TypeCode
func BenchmarkAddenda13TypeCode13(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13TypeCode13(b)
	}
}

// testODFINameAlphaNumeric validates ODFIName is alphanumeric
func testODFINameAlphaNumeric(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIName = "Wells®Fargo"
	err := addenda13.Validate()
	if !base.Match(err, ErrNonAlphanumeric) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestODFINameAlphaNumeric tests validating ODFIName is alphanumeric
func TestODFINameAlphaNumeric(t *testing.T) {
	testODFINameAlphaNumeric(t)
}

// BenchmarkODFINameAlphaNumeric benchmarks validating ODFIName is alphanumeric
func BenchmarkODFINameAlphaNumeric(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testODFINameAlphaNumeric(b)
	}
}

// testODFIIDNumberQualifierValid validates ODFIIDNumberQualifier is valid
func testODFIIDNumberQualifierValid(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIIDNumberQualifier = "®1"
	err := addenda13.Validate()
	if !base.Match(err, ErrIDNumberQualifier) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestODFIIDNumberQualifierValid tests validating ODFIIDNumberQualifier is valid
func TestODFIIDNumberQualifierValid(t *testing.T) {
	testODFIIDNumberQualifierValid(t)
}

func TestAddenda13SpecialCharacter(t *testing.T) {
	record := mockAddenda13()
	record.ODFIName = "Łomża"
	err := record.Validate()
	if err == nil {
		t.Error("Special character should have caused a validation failure")
	}

	record.SetValidation(&ValidateOpts{AllowSpecialCharacters: true})
	err = record.Validate()
	if err != nil {
		t.Error("Special character should have been allowed with override set.")
	}
}

// BenchmarkODFIIDNumberQualifierValid benchmarks validating ODFIIDNumberQualifier is valid
func BenchmarkODFIIDNumberQualifierValid(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testODFIIDNumberQualifierValid(b)
	}
}

// testODFIIdentificationAlphaNumeric validates ODFIIdentification is alphanumeric
func testODFIIdentificationAlphaNumeric(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIIdentification = "®121042882"
	err := addenda13.Validate()
	if !base.Match(err, ErrNonAlphanumeric) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestODFIIdentificationAlphaNumeric tests validating ODFIIdentification is alphanumeric
func TestODFIIdentificationAlphaNumeric(t *testing.T) {
	testODFIIdentificationAlphaNumeric(t)
}

// BenchmarkODFIIdentificationAlphaNumeric benchmarks validating ODFIIdentification is alphanumeric
func BenchmarkODFIIdentificationAlphaNumeric(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testODFIIdentificationAlphaNumeric(b)
	}
}

// testODFIBranchCountryCodeAlphaNumeric validates ODFIBranchCountryCode is alphanumeric
func testODFIBranchCountryCodeAlphaNumeric(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIBranchCountryCode = "U®"
	err := addenda13.Validate()
	if !base.Match(err, ErrNonAlphanumeric) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestODFIBranchCountryCodeAlphaNumeric tests validating ODFIBranchCountryCode is alphanumeric
func TestODFIBranchCountryCodeAlphaNumeric(t *testing.T) {
	testODFIBranchCountryCodeAlphaNumeric(t)
}

// BenchmarkODFIBranchCountryCodeAlphaNumeric benchmarks validating ODFIBranchCountryCode is alphanumeric
func BenchmarkODFIBranchCountryCodeAlphaNumeric(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testODFIBranchCountryCodeAlphaNumeric(b)
	}
}

// testAddenda13FieldInclusionTypeCode validates TypeCode fieldInclusion
func testAddenda13FieldInclusionTypeCode(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.TypeCode = ""
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionTypeCode tests validating TypeCode fieldInclusion
func TestAddenda13FieldInclusionTypeCode(t *testing.T) {
	testAddenda13FieldInclusionTypeCode(t)
}

// BenchmarkAddenda13FieldInclusionTypeCode benchmarks validating TypeCode fieldInclusion
func BenchmarkAddenda13FieldInclusionTypeCode(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionTypeCode(b)
	}
}

// testAddenda13FieldInclusionODFIName validates ODFIName fieldInclusion
func testAddenda13FieldInclusionODFIName(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIName = ""
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionODFIName tests validating ODFIName fieldInclusion
func TestAddenda13FieldInclusionODFIName(t *testing.T) {
	testAddenda13FieldInclusionODFIName(t)
}

// BenchmarkAddenda13FieldInclusionODFIName benchmarks validating ODFIName fieldInclusion
func BenchmarkAddenda13FieldInclusionODFIName(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionODFIName(b)
	}
}

// testAddenda13FieldInclusionODFIIDNumberQualifier validates ODFIIDNumberQualifier fieldInclusion
func testAddenda13FieldInclusionODFIIDNumberQualifier(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIIDNumberQualifier = ""
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionODFIIDNumberQualifier tests validating ODFIIDNumberQualifier fieldInclusion
func TestAddenda13FieldInclusionODFIIDNumberQualifier(t *testing.T) {
	testAddenda13FieldInclusionODFIIDNumberQualifier(t)
}

// BenchmarkAddenda13FieldInclusionODFIIDNumberQualifier benchmarks validating ODFIIDNumberQualifier fieldInclusion
func BenchmarkAddenda13FieldInclusionODFIIDNumberQualifier(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionODFIIDNumberQualifier(b)
	}
}

// testAddenda13FieldInclusionODFIIdentification validates ODFIIdentification fieldInclusion
func testAddenda13FieldInclusionODFIIdentification(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIIdentification = ""
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionODFIIdentification tests validating ODFIIdentification fieldInclusion
func TestAddenda13FieldInclusionODFIIdentification(t *testing.T) {
	testAddenda13FieldInclusionODFIIdentification(t)
}

// BenchmarkAddenda13FieldInclusionODFIIdentification benchmarks validating ODFIIdentification fieldInclusion
func BenchmarkAddenda13FieldInclusionODFIIdentification(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionODFIIdentification(b)
	}
}

// testAddenda13FieldInclusionODFIBranchCountryCode validates ODFIBranchCountryCode fieldInclusion
func testAddenda13FieldInclusionODFIBranchCountryCode(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.ODFIBranchCountryCode = ""
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionODFIBranchCountryCode tests validating ODFIBranchCountryCode fieldInclusion
func TestAddenda13FieldInclusionODFIBranchCountryCode(t *testing.T) {
	testAddenda13FieldInclusionODFIBranchCountryCode(t)
}

// BenchmarkAddenda13FieldInclusionODFIBranchCountryCode benchmarks validating ODFIBranchCountryCode fieldInclusion
func BenchmarkAddenda13FieldInclusionODFIBranchCountryCode(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionODFIBranchCountryCode(b)
	}
}

// testAddenda13FieldInclusionEntryDetailSequenceNumber validates EntryDetailSequenceNumber fieldInclusion
func testAddenda13FieldInclusionEntryDetailSequenceNumber(t testing.TB) {
	addenda13 := mockAddenda13()
	addenda13.EntryDetailSequenceNumber = -1
	err := addenda13.Validate()
	if !base.Match(err, ErrConstructor) {
		t.Errorf("%T: %s", err, err)
	}
}

// TestAddenda13FieldInclusionEntryDetailSequenceNumber tests validating
// EntryDetailSequenceNumber fieldInclusion
func TestAddenda13FieldInclusionEntryDetailSequenceNumber(t *testing.T) {
	testAddenda13FieldInclusionEntryDetailSequenceNumber(t)
}

// BenchmarkAddenda13FieldInclusionEntryDetailSequenceNumber benchmarks validating
// EntryDetailSequenceNumber fieldInclusion
func BenchmarkAddenda13FieldInclusionEntryDetailSequenceNumber(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13FieldInclusionEntryDetailSequenceNumber(b)
	}
}

// TestAddenda13String validates that a known parsed Addenda13 record can be return to a string of the same value
func testAddenda13String(t testing.TB) {
	addenda13 := NewAddenda13()
	var line = "713Wells Fargo                        121042882                         US             0000001"
	addenda13.Parse(line)

	if addenda13.String() != line {
		t.Errorf("Strings do not match")
	}
	if addenda13.TypeCode != "13" {
		t.Errorf("TypeCode Expected 13 got: %v", addenda13.TypeCode)
	}
}

// TestAddenda13String tests validating that a known parsed Addenda13 record can be return to a string of the same value
func TestAddenda13String(t *testing.T) {
	testAddenda13String(t)
}

// BenchmarkAddenda13String benchmarks validating that a known parsed Addenda13 record can be return to a string of the same value
func BenchmarkAddenda13String(b *testing.B) {
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		testAddenda13String(b)
	}
}

// TestAddenda13RuneCountInString validates RuneCountInString
func TestAddenda13RuneCountInString(t *testing.T) {
	addenda13 := NewAddenda13()
	var line = "713Wells Fargo                        121042882                         US"
	addenda13.Parse(line)

	if addenda13.ODFIBranchCountryCode != "" {
		t.Error("Parsed with an invalid RuneCountInString not equal to 94")
	}
}