diff --git a/third_party/github.com/cloudsigma/cepgo/LICENSE b/third_party/github.com/cloudsigma/cepgo/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/third_party/github.com/cloudsigma/cepgo/LICENSE @@ -0,0 +1,202 @@ +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/third_party/github.com/cloudsigma/cepgo/README.md b/third_party/github.com/cloudsigma/cepgo/README.md new file mode 100644 index 0000000..1125d86 --- /dev/null +++ b/third_party/github.com/cloudsigma/cepgo/README.md @@ -0,0 +1,43 @@ +cepgo +===== + +Cepko implements easy-to-use communication with CloudSigma's VMs through a +virtual serial port without bothering with formatting the messages properly nor +parsing the output with the specific and sometimes confusing shell tools for +that purpose. + +Having the server definition accessible by the VM can be useful in various +ways. For example it is possible to easily determine from within the VM, which +network interfaces are connected to public and which to private network. +Another use is to pass some data to initial VM setup scripts, like setting the +hostname to the VM name or passing ssh public keys through server meta. + +Example usage: + + package main + + import ( + "fmt" + + "github.com/cloudsigma/cepgo" + ) + + func main() { + c := cepgo.NewCepgo() + result, err := c.Meta() + if err != nil { + panic(err) + } + fmt.Printf("%#v", result) + } + +Output: + + map[string]interface {}{ + "optimize_for":"custom", + "ssh_public_key":"ssh-rsa AAA...", + "description":"[...]", + } + +For more information take a look at the Server Context section of CloudSigma +API Docs: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html diff --git a/third_party/github.com/cloudsigma/cepgo/cepgo.go b/third_party/github.com/cloudsigma/cepgo/cepgo.go new file mode 100644 index 0000000..5250bcc --- /dev/null +++ b/third_party/github.com/cloudsigma/cepgo/cepgo.go @@ -0,0 +1,186 @@ +// Cepko implements easy-to-use communication with CloudSigma's VMs through a +// virtual serial port without bothering with formatting the messages properly +// nor parsing the output with the specific and sometimes confusing shell tools +// for that purpose. +// +// Having the server definition accessible by the VM can be useful in various +// ways. For example it is possible to easily determine from within the VM, +// which network interfaces are connected to public and which to private +// network. Another use is to pass some data to initial VM setup scripts, like +// setting the hostname to the VM name or passing ssh public keys through +// server meta. +// +// Example usage: +// +// package main +// +// import ( +// "fmt" +// +// "github.com/cloudsigma/cepgo" +// ) +// +// func main() { +// c := cepgo.NewCepgo() +// result, err := c.Meta() +// if err != nil { +// panic(err) +// } +// fmt.Printf("%#v", result) +// } +// +// Output: +// +// map[string]string{ +// "optimize_for":"custom", +// "ssh_public_key":"ssh-rsa AAA...", +// "description":"[...]", +// } +// +// For more information take a look at the Server Context section API Docs: +// http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html +package cepgo + +import ( + "bufio" + "encoding/json" + "errors" + "fmt" + "runtime" + + "github.com/tarm/goserial" +) + +const ( + requestPattern = "<\n%s\n>" + EOT = '\x04' // End Of Transmission +) + +var ( + SerialPort string = "/dev/ttyS1" + Baud int = 115200 +) + +// Sets the serial port. If the operating system is windows CloudSigma's server +// context is at COM2 port, otherwise (linux, freebsd, darwin) the port is +// being left to the default /dev/ttyS1. +func init() { + if runtime.GOOS == "windows" { + SerialPort = "COM2" + } +} + +// The default fetcher makes the connection to the serial port, +// writes given query and reads until the EOT symbol. +func fetchViaSerialPort(key string) ([]byte, error) { + config := &serial.Config{Name: SerialPort, Baud: Baud} + connection, err := serial.OpenPort(config) + if err != nil { + return nil, err + } + + query := fmt.Sprintf(requestPattern, key) + if _, err := connection.Write([]byte(query)); err != nil { + return nil, err + } + + reader := bufio.NewReader(connection) + answer, err := reader.ReadBytes(EOT) + if err != nil { + return nil, err + } + + return answer[0 : len(answer)-1], nil +} + +// Queries to the serial port can be executed only from instance of this type. +// The result from each of them can be either interface{}, map[string]string or +// a single in case of single value is returned. There is also a public metod +// who directly calls the fetcher and returns raw []byte from the serial port. +type Cepgo struct { + fetcher func(string) ([]byte, error) +} + +// Creates a Cepgo instance with the default serial port fetcher. +func NewCepgo() *Cepgo { + cepgo := new(Cepgo) + cepgo.fetcher = fetchViaSerialPort + return cepgo +} + +// Creates a Cepgo instance with custom fetcher. +func NewCepgoFetcher(fetcher func(string) ([]byte, error)) *Cepgo { + cepgo := new(Cepgo) + cepgo.fetcher = fetcher + return cepgo +} + +// Fetches raw []byte from the serial port using directly the fetcher member. +func (c *Cepgo) FetchRaw(key string) ([]byte, error) { + return c.fetcher(key) +} + +// Fetches a single key and tries to unmarshal the result to json and returns +// it. If the unmarshalling fails it's safe to assume the result it's just a +// string and returns it. +func (c *Cepgo) Key(key string) (interface{}, error) { + var result interface{} + + fetched, err := c.FetchRaw(key) + if err != nil { + return nil, err + } + + err = json.Unmarshal(fetched, &result) + if err != nil { + return string(fetched), nil + } + return result, nil +} + +// Fetches all the server context. Equivalent of c.Key("") +func (c *Cepgo) All() (interface{}, error) { + return c.Key("") +} + +// Fetches only the object meta field and makes sure to return a proper +// map[string]string +func (c *Cepgo) Meta() (map[string]string, error) { + rawMeta, err := c.Key("/meta/") + if err != nil { + return nil, err + } + + return typeAssertToMapOfStrings(rawMeta) +} + +// Fetches only the global context and makes sure to return a proper +// map[string]string +func (c *Cepgo) GlobalContext() (map[string]string, error) { + rawContext, err := c.Key("/global_context/") + if err != nil { + return nil, err + } + + return typeAssertToMapOfStrings(rawContext) +} + +// Just a little helper function that uses type assertions in order to convert +// a interface{} to map[string]string if this is possible. +func typeAssertToMapOfStrings(raw interface{}) (map[string]string, error) { + result := make(map[string]string) + + dictionary, ok := raw.(map[string]interface{}) + if !ok { + return nil, errors.New("Received bytes are formatted badly") + } + + for key, rawValue := range dictionary { + if value, ok := rawValue.(string); ok { + result[key] = value + } else { + return nil, errors.New("Server context metadata is formatted badly") + } + } + return result, nil +} diff --git a/third_party/github.com/cloudsigma/cepgo/cepgo_test.go b/third_party/github.com/cloudsigma/cepgo/cepgo_test.go new file mode 100644 index 0000000..8de1df9 --- /dev/null +++ b/third_party/github.com/cloudsigma/cepgo/cepgo_test.go @@ -0,0 +1,122 @@ +package cepgo + +import ( + "encoding/json" + "testing" +) + +func fetchMock(key string) ([]byte, error) { + context := []byte(`{ + "context": true, + "cpu": 4000, + "cpu_model": null, + "cpus_instead_of_cores": false, + "enable_numa": false, + "global_context": { + "some_global_key": "some_global_val" + }, + "grantees": [], + "hv_relaxed": false, + "hv_tsc": false, + "jobs": [], + "mem": 4294967296, + "meta": { + "base64_fields": "cloudinit-user-data", + "cloudinit-user-data": "I2Nsb3VkLWNvbmZpZwoKaG9zdG5hbWU6IGNvcmVvczE=", + "ssh_public_key": "ssh-rsa AAAAB2NzaC1yc2E.../hQ5D5 john@doe" + }, + "name": "coreos", + "nics": [ + { + "runtime": { + "interface_type": "public", + "ip_v4": { + "uuid": "31.171.251.74" + }, + "ip_v6": null + }, + "vlan": null + } + ], + "smp": 2, + "status": "running", + "uuid": "20a0059b-041e-4d0c-bcc6-9b2852de48b3" + }`) + + if key == "" { + return context, nil + } + + var marshalledContext map[string]interface{} + + err := json.Unmarshal(context, &marshalledContext) + if err != nil { + return nil, err + } + + if key[0] == '/' { + key = key[1:] + } + if key[len(key)-1] == '/' { + key = key[:len(key)-1] + } + + return json.Marshal(marshalledContext[key]) +} + +func TestAll(t *testing.T) { + cepgo := NewCepgoFetcher(fetchMock) + + result, err := cepgo.All() + if err != nil { + t.Error(err) + } + + for _, key := range []string{"meta", "name", "uuid", "global_context"} { + if _, ok := result.(map[string]interface{})[key]; !ok { + t.Errorf("%s not in all keys", key) + } + } +} + +func TestKey(t *testing.T) { + cepgo := NewCepgoFetcher(fetchMock) + + result, err := cepgo.Key("uuid") + if err != nil { + t.Error(err) + } + + if _, ok := result.(string); !ok { + t.Errorf("%#v\n", result) + + t.Error("Fetching the uuid did not return a string") + } +} + +func TestMeta(t *testing.T) { + cepgo := NewCepgoFetcher(fetchMock) + + meta, err := cepgo.Meta() + if err != nil { + t.Errorf("%#v\n", meta) + t.Error(err) + } + + if _, ok := meta["ssh_public_key"]; !ok { + t.Error("ssh_public_key is not in the meta") + } +} + +func TestGlobalContext(t *testing.T) { + cepgo := NewCepgoFetcher(fetchMock) + + result, err := cepgo.GlobalContext() + if err != nil { + t.Error(err) + } + + if _, ok := result["some_global_key"]; !ok { + t.Error("some_global_key is not in the global context") + } +}