diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 0000000..c98113f --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,14 @@ +name: Test +on: push +jobs: + test: + name: Test + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v2 + - uses: actions/setup-go@v2 + with: + go-version: '^1.16.0' + - name: Run test + run: make test \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5d37121 --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +.PHONY: test + +test: + @go test -v ./... + +fmt: + @go fmt ./... diff --git a/README.md b/README.md new file mode 100644 index 0000000..0870c4b --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# gcp-regions + +Library to validate GCP regions + +# License + +Apache-2.0 + +`data.go` is based on [GoogleCloudPlatform/region-picker](https://github.com/GoogleCloudPlatform/region-picker/blob/c7be626a97daebd1b1f7fb9b60ca4113961b2af7/data/regions.json). \ No newline at end of file diff --git a/data.go b/data.go new file mode 100644 index 0000000..9c2c34a --- /dev/null +++ b/data.go @@ -0,0 +1,167 @@ +package regions + +const REGION_DATA string = ` +{ + "asia-east1":{ + "name":"Taiwan", + "flag": "https://upload.wikimedia.org/wikipedia/commons/7/72/Flag_of_the_Republic_of_China.svg", + "latitude": 23.69781, + "longitude": 120.960515 + }, + "asia-east2":{ + "name":"Hong Kong", + "flag": "https://upload.wikimedia.org/wikipedia/commons/5/5b/Flag_of_Hong_Kong.svg", + "latitude": 22.396428, + "longitude": 114.109497 + }, + "asia-northeast1":{ + "name":"Tokyo", + "flag": "https://upload.wikimedia.org/wikipedia/en/9/9e/Flag_of_Japan.svg", + "latitude": 35.6762, + "longitude": 139.6503 + }, + "asia-northeast2":{ + "name":"Osaka", + "flag": "https://upload.wikimedia.org/wikipedia/en/9/9e/Flag_of_Japan.svg", + "latitude": 34.6937, + "longitude": 135.5023 + }, + "asia-northeast3":{ + "name":"Seoul", + "flag": "https://upload.wikimedia.org/wikipedia/commons/0/09/Flag_of_South_Korea.svg", + "latitude": 37.5665, + "longitude": 126.9780 + }, + "asia-south1":{ + "name":"Delhi", + "flag": "https://upload.wikimedia.org/wikipedia/en/4/41/Flag_of_India.svg", + "latitude": 19.0760, + "longitude": 72.8777 + }, + "asia-south2":{ + "name":"Mumbai", + "flag": "https://upload.wikimedia.org/wikipedia/en/4/41/Flag_of_India.svg", + "latitude": 28.7041, + "longitude": 77.1025 + }, + "asia-southeast1":{ + "name":"Singapore", + "flag": "https://upload.wikimedia.org/wikipedia/commons/4/48/Flag_of_Singapore.svg", + "latitude": 1.3521, + "longitude": 103.8198 + }, + "asia-southeast2":{ + "name":"Jakarta", + "flag": "https://upload.wikimedia.org/wikipedia/commons/9/9f/Flag_of_Indonesia.svg", + "latitude": -6.2088, + "longitude": 106.8456 + }, + "australia-southeast1":{ + "name":"Sydney", + "flag": "https://upload.wikimedia.org/wikipedia/commons/8/88/Flag_of_Australia_%28converted%29.svg", + "latitude": -33.8688, + "longitude": 151.2093 + }, + "australia-southeast2":{ + "name":"Melbourne", + "flag": "https://upload.wikimedia.org/wikipedia/commons/8/88/Flag_of_Australia_%28converted%29.svg", + "latitude": -37.8136, + "longitude": 144.9631 + }, + "europe-central2":{ + "name":"Warsaw, Poland", + "flag": "https://upload.wikimedia.org/wikipedia/en/1/12/Flag_of_Poland.svg", + "latitude": 52.2297, + "longitude": 21.0122 + }, + "europe-north1":{ + "name":"Hamina, Finland", + "flag": "https://upload.wikimedia.org/wikipedia/commons/b/bc/Flag_of_Finland.svg", + "latitude": 60.5693, + "longitude": 27.1878 + }, + "europe-west1":{ + "name":"Belgium", + "flag": "https://upload.wikimedia.org/wikipedia/commons/9/92/Flag_of_Belgium_%28civil%29.svg", + "latitude": 50.5039, + "longitude": 4.4699 + }, + "europe-west2":{ + "name":"London, UK", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/ae/Flag_of_the_United_Kingdom.svg", + "latitude": 51.5074, + "longitude": -0.1278 + }, + "europe-west3":{ + "name":"Frankfurt, Germany", + "flag": "https://upload.wikimedia.org/wikipedia/en/b/ba/Flag_of_Germany.svg", + "latitude": 50.1109, + "longitude": 8.6821 + }, + "europe-west4":{ + "name":"Netherlands", + "flag": "https://upload.wikimedia.org/wikipedia/commons/2/20/Flag_of_the_Netherlands.svg", + "latitude": 52.1326, + "longitude": 5.2913 + }, + "europe-west6":{ + "name":"Zurich, Switzerland", + "flag": "https://upload.wikimedia.org/wikipedia/commons/f/f3/Flag_of_Switzerland.svg", + "latitude": 47.3769, + "longitude": 8.5417 + }, + "northamerica-northeast1":{ + "name":"Montréal, Canada", + "flag": "https://upload.wikimedia.org/wikipedia/commons/d/d9/Flag_of_Canada_%28Pantone%29.svg", + "latitude": 45.5017, + "longitude": -73.5673 + }, + "southamerica-east1":{ + "name":"São Paulo", + "flag": "https://upload.wikimedia.org/wikipedia/en/0/05/Flag_of_Brazil.svg", + "latitude": -23.5505, + "longitude": -46.6333 + }, + "us-central1":{ + "name":"Iowa, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 41.8780, + "longitude": -93.0977 + }, + "us-east1":{ + "name":"South Carolina, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 33.8361, + "longitude": -81.1637 + }, + "us-east4":{ + "name":"Northern Virginia, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 38.8334, + "longitude": -77.2365 + }, + "us-west1":{ + "name":"Oregon, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 43.8041, + "longitude": -120.5542 + }, + "us-west2":{ + "name":"Los Angeles, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 34.0522, + "longitude": -118.2437 + }, + "us-west3":{ + "name":"Salt Lake City, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 40.7608, + "longitude": -111.8910 + }, + "us-west4":{ + "name":"Las Vegas, USA", + "flag": "https://upload.wikimedia.org/wikipedia/en/a/a4/Flag_of_the_United_States.svg", + "latitude": 36.1699, + "longitude": -115.1398 + } +}` diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..b27f256 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/ohkinozomu/gcp-regions + +go 1.17 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..e69de29 diff --git a/regions.go b/regions.go new file mode 100644 index 0000000..38adc16 --- /dev/null +++ b/regions.go @@ -0,0 +1,29 @@ +package regions + +import ( + "encoding/json" +) + +var list map[string]Region + +func init() { + list, _ = List() +} + +func List() (map[string]Region, error) { + data := []byte(REGION_DATA) + + var m map[string]Region + if err := json.Unmarshal(data, &m); err != nil { + return m, err + } + + return m, nil +} + +func IsValid(name string) bool { + if _, ok := list[name]; ok { + return true + } + return false +} diff --git a/regions_test.go b/regions_test.go new file mode 100644 index 0000000..a9d1ea0 --- /dev/null +++ b/regions_test.go @@ -0,0 +1,16 @@ +package regions + +import ( + "testing" +) + +func TestIsValid(t *testing.T) { + validRegionName := "us-central1" + if IsValid("us-central1") != true { + t.Fatalf("failed test: %v\n", validRegionName) + } + notValidRegionName := "us-central1000" + if IsValid(notValidRegionName) != false { + t.Fatalf("failed test: %v\n", notValidRegionName) + } +} diff --git a/types.go b/types.go new file mode 100644 index 0000000..b6f18fd --- /dev/null +++ b/types.go @@ -0,0 +1,8 @@ +package regions + +type Region struct { + Name string `json:"name"` + Flag string `json:"flag"` + Latitude float64 `json:"latitude"` + Longitude float64 `json:"longitude"` +}