package ut import ( "fmt" "testing" "github.com/go-playground/locales" "github.com/go-playground/locales/en" "github.com/go-playground/locales/en_CA" "github.com/go-playground/locales/nl" ) // NOTES: // - Run "go test" to run tests // - Run "gocov test | gocov report" to report on test converage by file // - Run "gocov test | gocov annotate -" to report on all code and functions, those ,marked with "MISS" were never called // // or // // -- may be a good idea to change to output path to somewherelike /tmp // go test -coverprofile cover.out && go tool cover -html=cover.out -o cover.html // func TestBasicTranslation(t *testing.T) { e := en.New() uni := New(e, e) en, found := uni.GetTranslator("en") // or fallback if fails to find 'en' if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } translations := []struct { key interface{} trans string expected error expectedError bool override bool }{ { key: "test_trans", trans: "Welcome {0}", expected: nil, }, { key: -1, trans: "Welcome {0}", expected: nil, }, { key: "test_trans2", trans: "{0} to the {1}.", expected: nil, }, { key: "test_trans3", trans: "Welcome {0} to the {1}", expected: nil, }, { key: "test_trans4", trans: "{0}{1}", expected: nil, }, { key: "test_trans", trans: "{0}{1}", expected: &ErrConflictingTranslation{locale: en.Locale(), key: "test_trans", text: "{0}{1}"}, expectedError: true, }, { key: -1, trans: "{0}{1}", expected: &ErrConflictingTranslation{locale: en.Locale(), key: -1, text: "{0}{1}"}, expectedError: true, }, { key: "test_trans", trans: "Welcome {0} to the {1}.", expected: nil, override: true, }, } for _, tt := range translations { err := en.Add(tt.key, tt.trans, tt.override) if err != tt.expected { if !tt.expectedError { t.Errorf("Expected '%s' Got '%s'", tt.expected, err) } else { if err.Error() != tt.expected.Error() { t.Errorf("Expected '%s' Got '%s'", tt.expected.Error(), err.Error()) } } } } tests := []struct { key interface{} params []string expected string expectedError bool }{ { key: "test_trans", params: []string{"Joeybloggs", "The Test"}, expected: "Welcome Joeybloggs to the The Test.", }, { key: "test_trans2", params: []string{"Joeybloggs", "The Test"}, expected: "Joeybloggs to the The Test.", }, { key: "test_trans3", params: []string{"Joeybloggs", "The Test"}, expected: "Welcome Joeybloggs to the The Test", }, { key: "test_trans4", params: []string{"Joeybloggs", "The Test"}, expected: "JoeybloggsThe Test", }, // bad translation { key: "non-existant-key", params: []string{"Joeybloggs", "The Test"}, expected: "", expectedError: true, }, } for _, tt := range tests { s, err := en.T(tt.key, tt.params...) if s != tt.expected { if !tt.expectedError && err != ErrUnknowTranslation { t.Errorf("Expected '%s' Got '%s'", tt.expected, s) } } } } func TestCardinalTranslation(t *testing.T) { e := en.New() uni := New(e, e) en, found := uni.GetTranslator("en") if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } translations := []struct { key interface{} trans string rule locales.PluralRule expected error expectedError bool override bool }{ // bad translation { key: "cardinal_test", trans: "You have a day left.", rule: locales.PluralRuleOne, expected: &ErrCardinalTranslation{text: fmt.Sprintf("error: parameter '%s' not found, may want to use 'Add' instead of 'AddCardinal'. locale: '%s' key: '%v' text: '%s'", paramZero, en.Locale(), "cardinal_test", "You have a day left.")}, expectedError: true, }, // bad translation { key: "cardinal_test", trans: "You have a day left few.", rule: locales.PluralRuleFew, expected: &ErrCardinalTranslation{text: fmt.Sprintf("error: cardinal plural rule '%s' does not exist for locale '%s' key: '%s' text: '%s'", locales.PluralRuleFew, en.Locale(), "cardinal_test", "You have a day left few.")}, expectedError: true, }, { key: "cardinal_test", trans: "You have {0} day", rule: locales.PluralRuleOne, expected: nil, }, { key: "cardinal_test", trans: "You have {0} days left.", rule: locales.PluralRuleOther, expected: nil, }, { key: "cardinal_test", trans: "You have {0} days left.", rule: locales.PluralRuleOther, expected: &ErrConflictingTranslation{locale: en.Locale(), key: "cardinal_test", rule: locales.PluralRuleOther, text: "You have {0} days left."}, expectedError: true, }, { key: "cardinal_test", trans: "You have {0} day left.", rule: locales.PluralRuleOne, expected: nil, override: true, }, } for _, tt := range translations { err := en.AddCardinal(tt.key, tt.trans, tt.rule, tt.override) if err != tt.expected { if !tt.expectedError || err.Error() != tt.expected.Error() { t.Errorf("Expected '' Got '%s'", err) } } } tests := []struct { key interface{} num float64 digits uint64 param string expected string expectedError bool }{ { key: "cardinal_test", num: 1, digits: 0, param: string(en.FmtNumber(1, 0)), expected: "You have 1 day left.", }, // bad translation key { key: "non-existant", num: 1, digits: 0, param: string(en.FmtNumber(1, 0)), expected: "", expectedError: true, }, } for _, tt := range tests { s, err := en.C(tt.key, tt.num, tt.digits, tt.param) if err != nil { if !tt.expectedError && err != ErrUnknowTranslation { t.Errorf("Expected '' Got '%s'", err) } } if s != tt.expected { t.Errorf("Expected '%s' Got '%s'", tt.expected, s) } } } func TestOrdinalTranslation(t *testing.T) { e := en.New() uni := New(e, e) en, found := uni.GetTranslator("en") if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } translations := []struct { key interface{} trans string rule locales.PluralRule expected error expectedError bool override bool }{ // bad translation { key: "day", trans: "st", rule: locales.PluralRuleOne, expected: &ErrOrdinalTranslation{text: fmt.Sprintf("error: parameter '%s' not found, may want to use 'Add' instead of 'AddOrdinal'. locale: '%s' key: '%v' text: '%s'", paramZero, en.Locale(), "day", "st")}, expectedError: true, }, // bad translation { key: "day", trans: "st", rule: locales.PluralRuleMany, expected: &ErrOrdinalTranslation{text: fmt.Sprintf("error: ordinal plural rule '%s' does not exist for locale '%s' key: '%s' text: '%s'", locales.PluralRuleMany, en.Locale(), "day", "st")}, expectedError: true, }, { key: "day", trans: "{0}st", rule: locales.PluralRuleOne, expected: nil, }, { key: "day", trans: "{0}nd", rule: locales.PluralRuleTwo, expected: nil, }, { key: "day", trans: "{0}rd", rule: locales.PluralRuleFew, expected: nil, }, { key: "day", trans: "{0}th", rule: locales.PluralRuleOther, expected: nil, }, // bad translation { key: "day", trans: "{0}th", rule: locales.PluralRuleOther, expected: &ErrConflictingTranslation{locale: en.Locale(), key: "day", rule: locales.PluralRuleOther, text: "{0}th"}, expectedError: true, }, { key: "day", trans: "{0}st", rule: locales.PluralRuleOne, expected: nil, override: true, }, } for _, tt := range translations { err := en.AddOrdinal(tt.key, tt.trans, tt.rule, tt.override) if err != tt.expected { if !tt.expectedError || err.Error() != tt.expected.Error() { t.Errorf("Expected '' Got '%s'", err) } } } tests := []struct { key interface{} num float64 digits uint64 param string expected string expectedError bool }{ { key: "day", num: 1, digits: 0, param: string(en.FmtNumber(1, 0)), expected: "1st", }, { key: "day", num: 2, digits: 0, param: string(en.FmtNumber(2, 0)), expected: "2nd", }, { key: "day", num: 3, digits: 0, param: string(en.FmtNumber(3, 0)), expected: "3rd", }, { key: "day", num: 4, digits: 0, param: string(en.FmtNumber(4, 0)), expected: "4th", }, { key: "day", num: 10258.43, digits: 0, param: string(en.FmtNumber(10258.43, 0)), expected: "10,258th", }, // bad translation { key: "d-day", num: 10258.43, digits: 0, param: string(en.FmtNumber(10258.43, 0)), expected: "", expectedError: true, }, } for _, tt := range tests { s, err := en.O(tt.key, tt.num, tt.digits, tt.param) if err != nil { if !tt.expectedError && err != ErrUnknowTranslation { t.Errorf("Expected '' Got '%s'", err) } } if s != tt.expected { t.Errorf("Expected '%s' Got '%s'", tt.expected, s) } } } func TestRangeTranslation(t *testing.T) { n := nl.New() uni := New(n, n) // dutch nl, found := uni.GetTranslator("nl") if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } translations := []struct { key interface{} trans string rule locales.PluralRule expected error expectedError bool override bool }{ // bad translation { key: "day", trans: "er -{1} dag vertrokken", rule: locales.PluralRuleOne, expected: &ErrRangeTranslation{text: fmt.Sprintf("error: parameter '%s' not found, are you sure you're adding a Range Translation? locale: '%s' key: '%s' text: '%s'", paramZero, nl.Locale(), "day", "er -{1} dag vertrokken")}, expectedError: true, }, // bad translation { key: "day", trans: "er {0}- dag vertrokken", rule: locales.PluralRuleMany, expected: &ErrRangeTranslation{text: fmt.Sprintf("error: range plural rule '%s' does not exist for locale '%s' key: '%s' text: '%s'", locales.PluralRuleMany, nl.Locale(), "day", "er {0}- dag vertrokken")}, expectedError: true, }, // bad translation { key: "day", trans: "er {0}- dag vertrokken", rule: locales.PluralRuleOne, expected: &ErrRangeTranslation{text: fmt.Sprintf("error: parameter '%s' not found, a Range Translation requires two parameters. locale: '%s' key: '%s' text: '%s'", paramOne, nl.Locale(), "day", "er {0}- dag vertrokken")}, expectedError: true, }, { key: "day", trans: "er {0}-{1} dag", rule: locales.PluralRuleOne, expected: nil, }, { key: "day", trans: "er zijn {0}-{1} dagen over", rule: locales.PluralRuleOther, expected: nil, }, // bad translation { key: "day", trans: "er zijn {0}-{1} dagen over", rule: locales.PluralRuleOther, expected: &ErrConflictingTranslation{locale: nl.Locale(), key: "day", rule: locales.PluralRuleOther, text: "er zijn {0}-{1} dagen over"}, expectedError: true, }, { key: "day", trans: "er {0}-{1} dag vertrokken", rule: locales.PluralRuleOne, expected: nil, override: true, }, } for _, tt := range translations { err := nl.AddRange(tt.key, tt.trans, tt.rule, tt.override) if err != tt.expected { if !tt.expectedError || err.Error() != tt.expected.Error() { t.Errorf("Expected '%#v' Got '%s'", tt.expected, err) } } } tests := []struct { key interface{} num1 float64 digits1 uint64 num2 float64 digits2 uint64 param1 string param2 string expected string expectedError bool }{ { key: "day", num1: 1, digits1: 0, num2: 2, digits2: 0, param1: string(nl.FmtNumber(1, 0)), param2: string(nl.FmtNumber(2, 0)), expected: "er zijn 1-2 dagen over", }, { key: "day", num1: 0, digits1: 0, num2: 1, digits2: 0, param1: string(nl.FmtNumber(0, 0)), param2: string(nl.FmtNumber(1, 0)), expected: "er 0-1 dag vertrokken", }, { key: "day", num1: 0, digits1: 0, num2: 2, digits2: 0, param1: string(nl.FmtNumber(0, 0)), param2: string(nl.FmtNumber(2, 0)), expected: "er zijn 0-2 dagen over", }, // bad translations from here { key: "d-day", num1: 0, digits1: 0, num2: 2, digits2: 0, param1: string(nl.FmtNumber(0, 0)), param2: string(nl.FmtNumber(2, 0)), expected: "", expectedError: true, }, } for _, tt := range tests { s, err := nl.R(tt.key, tt.num1, tt.digits1, tt.num2, tt.digits2, tt.param1, tt.param2) if err != nil { if !tt.expectedError && err != ErrUnknowTranslation { t.Errorf("Expected '' Got '%s'", err) } } if s != tt.expected { t.Errorf("Expected '%s' Got '%s'", tt.expected, s) } } } func TestFallbackTranslator(t *testing.T) { e := en.New() uni := New(e, e) en, found := uni.GetTranslator("en") if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } if en.Locale() != "en" { t.Errorf("Expected '%s' Got '%s'", "en", en.Locale()) } fallback, _ := uni.GetTranslator("nl") if fallback.Locale() != "en" { t.Errorf("Expected '%s' Got '%s'", "en", fallback.Locale()) } en, _ = uni.FindTranslator("nl", "en") if en.Locale() != "en" { t.Errorf("Expected '%s' Got '%s'", "en", en.Locale()) } fallback, _ = uni.FindTranslator("nl") if fallback.Locale() != "en" { t.Errorf("Expected '%s' Got '%s'", "en", fallback.Locale()) } } func TestAddTranslator(t *testing.T) { e := en.New() n := nl.New() uni := New(e, n) tests := []struct { trans locales.Translator expected error expectedError bool override bool }{ { trans: en_CA.New(), expected: nil, override: false, }, { trans: n, expected: &ErrExistingTranslator{locale: n.Locale()}, expectedError: true, override: false, }, { trans: e, expected: &ErrExistingTranslator{locale: e.Locale()}, expectedError: true, override: false, }, { trans: e, expected: nil, override: true, }, } for _, tt := range tests { err := uni.AddTranslator(tt.trans, tt.override) if err != tt.expected { if !tt.expectedError || err.Error() != tt.expected.Error() { t.Errorf("Expected '%s' Got '%s'", tt.expected, err) } } } } func TestVerifyTranslations(t *testing.T) { n := nl.New() // dutch uni := New(n, n) loc, _ := uni.GetTranslator("nl") if loc.Locale() != "nl" { t.Errorf("Expected '%s' Got '%s'", "nl", loc.Locale()) } // cardinal checks err := loc.AddCardinal("day", "je {0} dag hebben verlaten", locales.PluralRuleOne, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // fail cardinal rules expected := &ErrMissingPluralTranslation{locale: loc.Locale(), translationType: "plural", rule: locales.PluralRuleOther, key: "day"} err = loc.VerifyTranslations() if err == nil || err.Error() != expected.Error() { t.Errorf("Expected '%s' Got '%s'", expected, err) } // success cardinal err = loc.AddCardinal("day", "je {0} dagen hebben verlaten", locales.PluralRuleOther, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } err = loc.VerifyTranslations() if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // range checks err = loc.AddRange("day", "je {0}-{1} dagen hebben verlaten", locales.PluralRuleOther, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // fail range rules expected = &ErrMissingPluralTranslation{locale: loc.Locale(), translationType: "range", rule: locales.PluralRuleOne, key: "day"} err = loc.VerifyTranslations() if err == nil || err.Error() != expected.Error() { t.Errorf("Expected '%s' Got '%s'", expected, err) } // success range err = loc.AddRange("day", "je {0}-{1} dag hebben verlaten", locales.PluralRuleOne, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } err = loc.VerifyTranslations() if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // ok so 'nl' aka dutch, ony has one plural rule for ordinals, so going to switch to english from here which has 4 err = uni.AddTranslator(en.New(), false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } loc, _ = uni.GetTranslator("en") if loc.Locale() != "en" { t.Errorf("Expected '%s' Got '%s'", "en", loc.Locale()) } // ordinal checks err = loc.AddOrdinal("day", "{0}st", locales.PluralRuleOne, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } err = loc.AddOrdinal("day", "{0}rd", locales.PluralRuleFew, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } err = loc.AddOrdinal("day", "{0}th", locales.PluralRuleOther, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // fail ordinal rules expected = &ErrMissingPluralTranslation{locale: loc.Locale(), translationType: "ordinal", rule: locales.PluralRuleTwo, key: "day"} err = loc.VerifyTranslations() if err == nil || err.Error() != expected.Error() { t.Errorf("Expected '%s' Got '%s'", expected, err) } // success ordinal err = loc.AddOrdinal("day", "{0}nd", locales.PluralRuleTwo, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } err = loc.VerifyTranslations() if err != nil { t.Fatalf("Expected '' Got '%s'", err) } } func TestVerifyTranslationsWithNonStringKeys(t *testing.T) { n := nl.New() // dutch uni := New(n, n) loc, _ := uni.GetTranslator("nl") if loc.Locale() != "nl" { t.Errorf("Expected '%s' Got '%s'", "nl", loc.Locale()) } // cardinal checks err := loc.AddCardinal(-1, "je {0} dag hebben verlaten", locales.PluralRuleOne, false) if err != nil { t.Fatalf("Expected '' Got '%s'", err) } // fail cardinal rules expected := &ErrMissingPluralTranslation{locale: loc.Locale(), translationType: "plural", rule: locales.PluralRuleOther, key: -1} err = loc.VerifyTranslations() if err == nil || err.Error() != expected.Error() { t.Errorf("Expected '%s' Got '%s'", expected, err) } } func TestGetFallback(t *testing.T) { // dutch n := nl.New() e := en.New() uni := New(e, n) trans := uni.GetFallback() expected := "en" if trans.Locale() != expected { t.Errorf("Expected '%s' Got '%s'", expected, trans.Locale()) } } func TestVerifyUTTranslations(t *testing.T) { e := en.New() uni := New(e, e) en, found := uni.GetTranslator("en") if !found { t.Fatalf("Expected '%t' Got '%t'", true, found) } translations := []struct { key interface{} trans string rule locales.PluralRule expected error expectedError bool override bool }{ { key: "day", trans: "{0}st", rule: locales.PluralRuleOne, expected: nil, }, { key: "day", trans: "{0}nd", rule: locales.PluralRuleTwo, expected: nil, }, { key: "day", trans: "{0}rd", rule: locales.PluralRuleFew, expected: nil, }, // intentionally leaving out plural other // { // key: "day", // trans: "{0}th", // rule: locales.PluralRuleOther, // expected: nil, // }, } for _, tt := range translations { err := en.AddOrdinal(tt.key, tt.trans, tt.rule, tt.override) if err != tt.expected { if !tt.expectedError || err.Error() != tt.expected.Error() { t.Errorf("Expected '' Got '%s'", err) } } } expected := "error: missing 'ordinal' plural rule 'Other' for translation with key 'day' and locale 'en'" err := uni.VerifyTranslations() if err == nil || err.Error() != expected { t.Fatalf("Expected '%s' Got '%s'", expected, err) } err = en.AddOrdinal("day", "{0}th", locales.PluralRuleOther, false) if err != nil { t.Fatalf("Expected '%v' Got '%s'", nil, err) } err = uni.VerifyTranslations() if err != nil { t.Fatalf("Expected '%v' Got '%s'", nil, err) } }