├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── money.go └── money_test.go /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution; 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | 25 | ## Community Guidelines 26 | 27 | This project follows [Google's Open Source Community 28 | Guidelines](https://opensource.google.com/conduct/). 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-pbmoney 2 | 3 | This Go package contains utilities and arithmetic functions to work with 4 | Google’s [money.proto](https://github.com/googleapis/googleapis/blob/master/google/type/money.proto). 5 | 6 | These utilities can be used to check validity and sign of the Money amount, 7 | as well as arithmetic operations like adding two Money messages. 8 | 9 | See [GoDoc](https://godoc.org/github.com/google/go-pbmoney) for package 10 | documentation. 11 | 12 | go get -u github.com/google/go-pbmoney 13 | 14 | ----- 15 | 16 | See [LICENSE](LICENSE) for licensing information and 17 | [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines. 18 | 19 | This is not an official Google project. 20 | -------------------------------------------------------------------------------- /money.go: -------------------------------------------------------------------------------- 1 | // Copyright 2018 Google LLC 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // https://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | // Package pbmoney has utilities relating to Google's money.proto. 16 | // 17 | // money.proto can be found at 18 | // https://github.com/googleapis/googleapis/blob/master/google/type/money.proto, 19 | // and the Go package for it is at 20 | // https://godoc.org/google.golang.org/genproto/googleapis/type/Money. 21 | package pbmoney 22 | 23 | import ( 24 | "errors" 25 | 26 | pb "google.golang.org/genproto/googleapis/type/money" 27 | ) 28 | 29 | const ( 30 | nanosMin = -999999999 31 | nanosMax = +999999999 32 | nanosMod = 1000000000 33 | ) 34 | 35 | var ( 36 | // ErrInvalidValue is returned if the specified money amount is not valid. 37 | ErrInvalidValue = errors.New("one of the specified money values is invalid") 38 | 39 | // ErrMismatchingCurrency is returned if two values don't have the same currency code. 40 | ErrMismatchingCurrency = errors.New("mismatching currency codes") 41 | ) 42 | 43 | // IsValid checks if specified value has a valid units/nanos signs and ranges. 44 | func IsValid(m pb.Money) bool { 45 | return signMatches(m) && validNanos(m.GetNanos()) 46 | } 47 | 48 | func signMatches(m pb.Money) bool { 49 | return m.GetNanos() == 0 || m.GetUnits() == 0 || (m.GetNanos() < 0) == (m.GetUnits() < 0) 50 | } 51 | 52 | func validNanos(nanos int32) bool { return nanosMin <= nanos && nanos <= nanosMax } 53 | 54 | // IsZero returns true if the specified money value is equal to zero. 55 | func IsZero(m pb.Money) bool { return m.GetUnits() == 0 && m.GetNanos() == 0 } 56 | 57 | // IsPositive returns true if the specified money value is valid and is 58 | // positive. 59 | func IsPositive(m pb.Money) bool { 60 | return IsValid(m) && m.GetUnits() > 0 || (m.GetUnits() == 0 && m.GetNanos() > 0) 61 | } 62 | 63 | // IsNegative returns true if the specified money value is valid and is 64 | // negative. 65 | func IsNegative(m pb.Money) bool { 66 | return IsValid(m) && m.GetUnits() < 0 || (m.GetUnits() == 0 && m.GetNanos() < 0) 67 | } 68 | 69 | // AreSameCurrency returns true if values l and r have a currency code and 70 | // they are the same values. 71 | func AreSameCurrency(l, r pb.Money) bool { 72 | return l.GetCurrencyCode() == r.GetCurrencyCode() && l.GetCurrencyCode() != "" 73 | } 74 | 75 | // AreEquals returns true if values l and r are the equal, including the 76 | // currency. This does not check validity of the provided values. 77 | func AreEquals(l, r pb.Money) bool { 78 | return l.GetCurrencyCode() == r.GetCurrencyCode() && 79 | l.GetUnits() == r.GetUnits() && l.GetNanos() == r.GetNanos() 80 | } 81 | 82 | // Negate returns the same amount with the sign negated. 83 | func Negate(m pb.Money) pb.Money { 84 | return pb.Money{ 85 | Units: -m.GetUnits(), 86 | Nanos: -m.GetNanos(), 87 | CurrencyCode: m.GetCurrencyCode()} 88 | } 89 | 90 | // Must panics if the given error is not nil. This can be used with other 91 | // functions like: "m := Must(Sum(a,b))". 92 | func Must(v pb.Money, err error) pb.Money { 93 | if err != nil { 94 | panic(err) 95 | } 96 | return v 97 | } 98 | 99 | // Sum adds two values. Returns an error if one of the values are invalid or 100 | // currency codes are not matching (unless currency code is unspecified for 101 | // both). 102 | func Sum(l, r pb.Money) (pb.Money, error) { 103 | if !IsValid(l) || !IsValid(r) { 104 | return pb.Money{}, ErrInvalidValue 105 | } else if l.GetCurrencyCode() != r.GetCurrencyCode() { 106 | return pb.Money{}, ErrMismatchingCurrency 107 | } 108 | units := l.GetUnits() + r.GetUnits() 109 | nanos := l.GetNanos() + r.GetNanos() 110 | 111 | if (units >= 0 && nanos >= 0) || (units <= 0 && nanos <= 0) { 112 | // same sign 113 | units += int64(nanos / nanosMod) 114 | nanos = nanos % nanosMod 115 | } else { 116 | // different sign. nanos guaranteed to not to go over the limit 117 | if units > 0 { 118 | units-- 119 | nanos += nanosMod 120 | } else { 121 | units++ 122 | nanos -= nanosMod 123 | } 124 | } 125 | 126 | return pb.Money{ 127 | Units: units, 128 | Nanos: nanos, 129 | CurrencyCode: l.GetCurrencyCode()}, nil 130 | } 131 | -------------------------------------------------------------------------------- /money_test.go: -------------------------------------------------------------------------------- 1 | // Copyright 2018 Google LLC 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // https://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | package pbmoney 15 | 16 | import ( 17 | "fmt" 18 | "reflect" 19 | "testing" 20 | 21 | pb "google.golang.org/genproto/googleapis/type/money" 22 | ) 23 | 24 | func mmc(u int64, n int32, c string) pb.Money { return pb.Money{Units: u, Nanos: n, CurrencyCode: c} } 25 | func mm(u int64, n int32) pb.Money { return mmc(u, n, "") } 26 | 27 | func TestIsValid(t *testing.T) { 28 | tests := []struct { 29 | name string 30 | in pb.Money 31 | want bool 32 | }{ 33 | {"valid -/-", mm(-981273891273, -999999999), true}, 34 | {"invalid -/+", mm(-981273891273, +999999999), false}, 35 | {"valid +/+", mm(981273891273, 999999999), true}, 36 | {"invalid +/-", mm(981273891273, -999999999), false}, 37 | {"invalid +/+overflow", mm(3, 1000000000), false}, 38 | {"invalid +/-overflow", mm(3, -1000000000), false}, 39 | {"invalid -/+overflow", mm(-3, 1000000000), false}, 40 | {"invalid -/-overflow", mm(-3, -1000000000), false}, 41 | } 42 | for _, tt := range tests { 43 | t.Run(tt.name, func(t *testing.T) { 44 | if got := IsValid(tt.in); got != tt.want { 45 | t.Errorf("IsValid(%v) = %v, want %v", tt.in, got, tt.want) 46 | } 47 | }) 48 | } 49 | } 50 | 51 | func TestIsZero(t *testing.T) { 52 | tests := []struct { 53 | name string 54 | in pb.Money 55 | want bool 56 | }{ 57 | {"zero", mm(0, 0), true}, 58 | {"not-zero (-/+)", mm(-1, +1), false}, 59 | {"not-zero (-/-)", mm(-1, -1), false}, 60 | {"not-zero (+/+)", mm(+1, +1), false}, 61 | {"not-zero (+/-)", mm(+1, -1), false}, 62 | } 63 | for _, tt := range tests { 64 | t.Run(tt.name, func(t *testing.T) { 65 | if got := IsZero(tt.in); got != tt.want { 66 | t.Errorf("IsZero(%v) = %v, want %v", tt.in, got, tt.want) 67 | } 68 | }) 69 | } 70 | } 71 | 72 | func TestIsPositive(t *testing.T) { 73 | tests := []struct { 74 | name string 75 | in pb.Money 76 | want bool 77 | }{ 78 | {"zero", mm(0, 0), false}, 79 | {"positive (+/+)", mm(+1, +1), true}, 80 | {"invalid (-/+)", mm(-1, +1), false}, 81 | {"negative (-/-)", mm(-1, -1), false}, 82 | {"invalid (+/-)", mm(+1, -1), false}, 83 | } 84 | for _, tt := range tests { 85 | t.Run(tt.name, func(t *testing.T) { 86 | if got := IsPositive(tt.in); got != tt.want { 87 | t.Errorf("IsPositive(%v) = %v, want %v", tt.in, got, tt.want) 88 | } 89 | }) 90 | } 91 | } 92 | 93 | func TestIsNegative(t *testing.T) { 94 | tests := []struct { 95 | name string 96 | in pb.Money 97 | want bool 98 | }{ 99 | {"zero", mm(0, 0), false}, 100 | {"positive (+/+)", mm(+1, +1), false}, 101 | {"invalid (-/+)", mm(-1, +1), false}, 102 | {"negative (-/-)", mm(-1, -1), true}, 103 | {"invalid (+/-)", mm(+1, -1), false}, 104 | } 105 | for _, tt := range tests { 106 | t.Run(tt.name, func(t *testing.T) { 107 | if got := IsNegative(tt.in); got != tt.want { 108 | t.Errorf("IsNegative(%v) = %v, want %v", tt.in, got, tt.want) 109 | } 110 | }) 111 | } 112 | } 113 | 114 | func TestAreSameCurrency(t *testing.T) { 115 | type args struct { 116 | l pb.Money 117 | r pb.Money 118 | } 119 | tests := []struct { 120 | name string 121 | args args 122 | want bool 123 | }{ 124 | {"both empty currency", args{mmc(1, 0, ""), mmc(2, 0, "")}, false}, 125 | {"left empty currency", args{mmc(1, 0, ""), mmc(2, 0, "USD")}, false}, 126 | {"right empty currency", args{mmc(1, 0, "USD"), mmc(2, 0, "")}, false}, 127 | {"mismatching", args{mmc(1, 0, "USD"), mmc(2, 0, "CAD")}, false}, 128 | {"matching", args{mmc(1, 0, "USD"), mmc(2, 0, "USD")}, true}, 129 | } 130 | for _, tt := range tests { 131 | t.Run(tt.name, func(t *testing.T) { 132 | if got := AreSameCurrency(tt.args.l, tt.args.r); got != tt.want { 133 | t.Errorf("AreSameCurrency([%v],[%v]) = %v, want %v", tt.args.l, tt.args.r, got, tt.want) 134 | } 135 | }) 136 | } 137 | } 138 | 139 | func TestAreEquals(t *testing.T) { 140 | type args struct { 141 | l pb.Money 142 | r pb.Money 143 | } 144 | tests := []struct { 145 | name string 146 | args args 147 | want bool 148 | }{ 149 | {"equals", args{mmc(1, 2, "USD"), mmc(1, 2, "USD")}, true}, 150 | {"mismatching currency", args{mmc(1, 2, "USD"), mmc(1, 2, "CAD")}, false}, 151 | {"mismatching units", args{mmc(10, 20, "USD"), mmc(1, 20, "USD")}, false}, 152 | {"mismatching nanos", args{mmc(1, 2, "USD"), mmc(1, 20, "USD")}, false}, 153 | {"negated", args{mmc(1, 2, "USD"), mmc(-1, -2, "USD")}, false}, 154 | } 155 | for _, tt := range tests { 156 | t.Run(tt.name, func(t *testing.T) { 157 | if got := AreEquals(tt.args.l, tt.args.r); got != tt.want { 158 | t.Errorf("AreEquals([%v],[%v]) = %v, want %v", tt.args.l, tt.args.r, got, tt.want) 159 | } 160 | }) 161 | } 162 | } 163 | 164 | func TestNegate(t *testing.T) { 165 | tests := []struct { 166 | name string 167 | in pb.Money 168 | want pb.Money 169 | }{ 170 | {"zero", mm(0, 0), mm(0, 0)}, 171 | {"negative", mm(-1, -200), mm(1, 200)}, 172 | {"positive", mm(1, 200), mm(-1, -200)}, 173 | {"carries currency code", mmc(0, 0, "XXX"), mmc(0, 0, "XXX")}, 174 | } 175 | for _, tt := range tests { 176 | t.Run(tt.name, func(t *testing.T) { 177 | if got := Negate(tt.in); !AreEquals(got, tt.want) { 178 | t.Errorf("Negate([%v]) = %v, want %v", tt.in, got, tt.want) 179 | } 180 | }) 181 | } 182 | } 183 | 184 | func TestMust_pass(t *testing.T) { 185 | v := Must(mm(2, 3), nil) 186 | if !AreEquals(v, mm(2, 3)) { 187 | t.Errorf("returned the wrong value: %v", v) 188 | } 189 | } 190 | 191 | func TestMust_panic(t *testing.T) { 192 | defer func() { 193 | if r := recover(); r != nil { 194 | t.Logf("panic captured: %v", r) 195 | } 196 | }() 197 | Must(mm(2, 3), fmt.Errorf("some error")) 198 | t.Fatal("this should not have executed due to the panic above") 199 | } 200 | 201 | func TestSum(t *testing.T) { 202 | type args struct { 203 | l pb.Money 204 | r pb.Money 205 | } 206 | tests := []struct { 207 | name string 208 | args args 209 | want pb.Money 210 | wantErr error 211 | }{ 212 | {"0+0=0", args{mm(0, 0), mm(0, 0)}, mm(0, 0), nil}, 213 | {"Error: currency code on left", args{mmc(0, 0, "XXX"), mm(0, 0)}, mm(0, 0), ErrMismatchingCurrency}, 214 | {"Error: currency code on right", args{mm(0, 0), mmc(0, 0, "YYY")}, mm(0, 0), ErrMismatchingCurrency}, 215 | {"Error: currency code mismatch", args{mmc(0, 0, "AAA"), mmc(0, 0, "BBB")}, mm(0, 0), ErrMismatchingCurrency}, 216 | {"Error: invalid +/-", args{mm(+1, -1), mm(0, 0)}, mm(0, 0), ErrInvalidValue}, 217 | {"Error: invalid -/+", args{mm(0, 0), mm(-1, +2)}, mm(0, 0), ErrInvalidValue}, 218 | {"Error: invalid nanos", args{mm(0, 1000000000), mm(1, 0)}, mm(0, 0), ErrInvalidValue}, 219 | {"both positive (no carry)", args{mm(2, 200000000), mm(2, 200000000)}, mm(4, 400000000), nil}, 220 | {"both positive (nanos=max)", args{mm(2, 111111111), mm(2, 888888888)}, mm(4, 999999999), nil}, 221 | {"both positive (carry)", args{mm(2, 200000000), mm(2, 900000000)}, mm(5, 100000000), nil}, 222 | {"both negative (no carry)", args{mm(-2, -200000000), mm(-2, -200000000)}, mm(-4, -400000000), nil}, 223 | {"both negative (carry)", args{mm(-2, -200000000), mm(-2, -900000000)}, mm(-5, -100000000), nil}, 224 | {"mixed (larger positive, just decimals)", args{mm(11, 0), mm(-2, 0)}, mm(9, 0), nil}, 225 | {"mixed (larger negative, just decimals)", args{mm(-11, 0), mm(2, 0)}, mm(-9, 0), nil}, 226 | {"mixed (larger positive, no borrow)", args{mm(11, 100000000), mm(-2, -100000000)}, mm(9, 0), nil}, 227 | {"mixed (larger positive, with borrow)", args{mm(11, 100000000), mm(-2, -9000000 /*.09*/)}, mm(9, 91000000 /*.091*/), nil}, 228 | {"mixed (larger negative, no borrow)", args{mm(-11, -100000000), mm(2, 100000000)}, mm(-9, 0), nil}, 229 | {"mixed (larger negative, with borrow)", args{mm(-11, -100000000), mm(2, 9000000 /*.09*/)}, mm(-9, -91000000 /*.091*/), nil}, 230 | {"0+negative", args{mm(0, 0), mm(-2, -100000000)}, mm(-2, -100000000), nil}, 231 | {"negative+0", args{mm(-2, -100000000), mm(0, 0)}, mm(-2, -100000000), nil}, 232 | {"0.61+0", args{mm(0, 610000000), mm(0, 0)}, mm(0, 610000000), nil}, 233 | {"-0.61+0", args{mm(0, -610000000), mm(0, 0)}, mm(0, -610000000), nil}, 234 | } 235 | for _, tt := range tests { 236 | t.Run(tt.name, func(t *testing.T) { 237 | got, err := Sum(tt.args.l, tt.args.r) 238 | if err != tt.wantErr { 239 | t.Errorf("Sum([%v],[%v]): expected err=\"%v\" got=\"%v\"", tt.args.l, tt.args.r, tt.wantErr, err) 240 | } 241 | if !reflect.DeepEqual(got, tt.want) { 242 | t.Errorf("Sum([%v],[%v]) = %v, want %v", tt.args.l, tt.args.r, got, tt.want) 243 | } 244 | }) 245 | } 246 | } 247 | --------------------------------------------------------------------------------