From 7fcf10b990803c90917c21b831c589f77c2ef37c Mon Sep 17 00:00:00 2001 From: Huan Wang Date: Mon, 20 Aug 2018 09:53:12 -0600 Subject: [PATCH] move formcontent to om related to issue #196, I created the formcontent in my repo, now there is a request to move the code into a pivotal repo to remove the dependency on a personal repo. [#159835480] --- Gopkg.lock | 9 - Gopkg.toml | 5 +- commands/fakes/multipart.go | 2 +- commands/import_installation_test.go | 2 +- commands/upload_product_test.go | 2 +- commands/upload_stemcell.go | 2 +- commands/upload_stemcell_test.go | 2 +- .../formcontent.go | 4 +- formcontent/formcontent_suite_test.go | 13 ++ formcontent/formcontent_test.go | 174 +++++++++++++++ main.go | 2 +- .../fredwangwang/formcontent/LICENSE | 201 ------------------ 12 files changed, 196 insertions(+), 222 deletions(-) rename {vendor/github.com/fredwangwang/formcontent => formcontent}/formcontent.go (97%) create mode 100644 formcontent/formcontent_suite_test.go create mode 100644 formcontent/formcontent_test.go delete mode 100644 vendor/github.com/fredwangwang/formcontent/LICENSE diff --git a/Gopkg.lock b/Gopkg.lock index 4ff5dfa58..a2d12f7f0 100644 --- a/Gopkg.lock +++ b/Gopkg.lock @@ -61,14 +61,6 @@ pruneopts = "NUT" revision = "250da0e0e68ce3367b4302f34218f6c064eb9559" -[[projects]] - branch = "threaded" - digest = "1:98b20ab737949ad7e1f922bbbcfb8599aacb954b36fe89efffcb9c11e59ff314" - name = "github.com/fredwangwang/formcontent" - packages = ["."] - pruneopts = "NUT" - revision = "399803444952249b6f88be8c4a2adc4dae5f5270" - [[projects]] digest = "1:81466b4218bf6adddac2572a30ac733a9255919bc2f470b4827a317bd4ee1756" name = "github.com/ghodss/yaml" @@ -301,7 +293,6 @@ "github.com/PuerkitoBio/goquery", "github.com/cloudfoundry/bosh-cli/director/template", "github.com/cppforlife/go-patch/patch", - "github.com/fredwangwang/formcontent", "github.com/ghodss/yaml", "github.com/google/go-querystring/query", "github.com/gosuri/uilive", diff --git a/Gopkg.toml b/Gopkg.toml index 1f5ef6b7f..761582ef6 100644 --- a/Gopkg.toml +++ b/Gopkg.toml @@ -13,9 +13,6 @@ required=[ name = "github.com/pivotal-cf/kiln" branch = "master" -[[constraint]] - name = "github.com/fredwangwang/formcontent" - branch = "threaded" [[constraint]] name = "github.com/onsi/ginkgo" - version = "1.4.0" + version = "1.4.0" \ No newline at end of file diff --git a/commands/fakes/multipart.go b/commands/fakes/multipart.go index 783271aac..fa8d04d5a 100644 --- a/commands/fakes/multipart.go +++ b/commands/fakes/multipart.go @@ -4,7 +4,7 @@ package fakes import ( "sync" - "github.com/fredwangwang/formcontent" + "github.com/pivotal-cf/om/formcontent" ) type Multipart struct { diff --git a/commands/import_installation_test.go b/commands/import_installation_test.go index f8a6a5b7d..87cba450e 100644 --- a/commands/import_installation_test.go +++ b/commands/import_installation_test.go @@ -6,11 +6,11 @@ import ( "io/ioutil" "strings" - "github.com/fredwangwang/formcontent" "github.com/pivotal-cf/jhanda" "github.com/pivotal-cf/om/api" "github.com/pivotal-cf/om/commands" "github.com/pivotal-cf/om/commands/fakes" + "github.com/pivotal-cf/om/formcontent" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" diff --git a/commands/upload_product_test.go b/commands/upload_product_test.go index aa09acb51..8b0cd533b 100644 --- a/commands/upload_product_test.go +++ b/commands/upload_product_test.go @@ -7,12 +7,12 @@ import ( "os" "strings" - "github.com/fredwangwang/formcontent" "github.com/pivotal-cf/jhanda" "github.com/pivotal-cf/om/api" "github.com/pivotal-cf/om/commands" "github.com/pivotal-cf/om/commands/fakes" "github.com/pivotal-cf/om/extractor" + "github.com/pivotal-cf/om/formcontent" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" diff --git a/commands/upload_stemcell.go b/commands/upload_stemcell.go index badc7ba1a..1c222ef17 100644 --- a/commands/upload_stemcell.go +++ b/commands/upload_stemcell.go @@ -4,9 +4,9 @@ import ( "fmt" "path/filepath" - "github.com/fredwangwang/formcontent" "github.com/pivotal-cf/jhanda" "github.com/pivotal-cf/om/api" + "github.com/pivotal-cf/om/formcontent" "github.com/pivotal-cf/om/validator" "strconv" diff --git a/commands/upload_stemcell_test.go b/commands/upload_stemcell_test.go index 8d7242e4d..368f98cc2 100644 --- a/commands/upload_stemcell_test.go +++ b/commands/upload_stemcell_test.go @@ -7,11 +7,11 @@ import ( "os" "strings" - "github.com/fredwangwang/formcontent" "github.com/pivotal-cf/jhanda" "github.com/pivotal-cf/om/api" "github.com/pivotal-cf/om/commands" "github.com/pivotal-cf/om/commands/fakes" + "github.com/pivotal-cf/om/formcontent" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" diff --git a/vendor/github.com/fredwangwang/formcontent/formcontent.go b/formcontent/formcontent.go similarity index 97% rename from vendor/github.com/fredwangwang/formcontent/formcontent.go rename to formcontent/formcontent.go index f5b3f3060..90f57620c 100644 --- a/vendor/github.com/fredwangwang/formcontent/formcontent.go +++ b/formcontent/formcontent.go @@ -27,7 +27,7 @@ type ContentSubmission struct { ContentLength int64 } -func NewForm() (*Form) { +func NewForm() *Form { buf := &bytes.Buffer{} pr, pw := io.Pipe() @@ -80,7 +80,7 @@ func (f *Form) AddFile(key string, path string) error { return nil } -func (f *Form) Finalize() (ContentSubmission) { +func (f *Form) Finalize() ContentSubmission { f.formWriter.Close() // add the length of form fields, including trailing boundary diff --git a/formcontent/formcontent_suite_test.go b/formcontent/formcontent_suite_test.go new file mode 100644 index 000000000..a284b5890 --- /dev/null +++ b/formcontent/formcontent_suite_test.go @@ -0,0 +1,13 @@ +package formcontent_test + +import ( + "testing" + + . "github.com/onsi/ginkgo" + . "github.com/onsi/gomega" +) + +func TestFormcontent(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Formcontent Suite") +} diff --git a/formcontent/formcontent_test.go b/formcontent/formcontent_test.go new file mode 100644 index 000000000..44f8d466c --- /dev/null +++ b/formcontent/formcontent_test.go @@ -0,0 +1,174 @@ +package formcontent_test + +import ( + . "github.com/onsi/ginkgo" + . "github.com/onsi/gomega" + "github.com/pivotal-cf/om/formcontent" + + "io/ioutil" + "os" +) + +var _ = Describe("Formcontent", func() { + var form *formcontent.Form + + Describe("AddFile", func() { + var ( + fileWithContent1 string + fileWithContent2 string + ) + + BeforeEach(func() { + handle1, err := ioutil.TempFile("", "") + Expect(err).NotTo(HaveOccurred()) + + _, err = handle1.WriteString("some content") + Expect(err).NotTo(HaveOccurred()) + + fileWithContent1 = handle1.Name() + + handle2, err := ioutil.TempFile("", "") + Expect(err).NotTo(HaveOccurred()) + + _, err = handle2.WriteString("some more content") + Expect(err).NotTo(HaveOccurred()) + + fileWithContent2 = handle2.Name() + + form = formcontent.NewForm() + }) + + AfterEach(func() { + os.Remove(fileWithContent1) + os.Remove(fileWithContent2) + }) + + It("writes out the provided file as a multipart form using the writer", func() { + err := form.AddFile("something[file1]", fileWithContent1) + Expect(err).NotTo(HaveOccurred()) + + err = form.AddFile("something[file2]", fileWithContent2) + Expect(err).NotTo(HaveOccurred()) + + submission := form.Finalize() + + content, err := ioutil.ReadAll(submission.Content) + Expect(err).NotTo(HaveOccurred()) + + Expect(string(content)).To(MatchRegexp(`^--\w+\r\nContent-Disposition: form-data; name=\"something\[file1\]\"; filename=\"\w+\"\r\n` + + `Content-Type: application/octet-stream\r\n\r\n` + + `some content` + + `\r\n--\w+\r\nContent-Disposition: form-data; name=\"something\[file2\]\"; filename=\"\w+\"\r\n` + + `Content-Type: application/octet-stream\r\n\r\n` + + `some more content` + + `\r\n--\w+--\r\n$`)) + }) + + Context("when the file provided is empty", func() { + It("returns an error", func() { + emptyFile, err := ioutil.TempFile("", "") + Expect(err).NotTo(HaveOccurred()) + + form := formcontent.NewForm() + + err = form.AddFile("foo", emptyFile.Name()) + Expect(err).To(MatchError("file provided has no content")) + }) + }) + + Context("when an error occurs", func() { + Context("when the original file cannot be read", func() { + It("returns an error", func() { + form := formcontent.NewForm() + + err := form.AddFile("foo", "/file/does/not/exist") + Expect(err).To(MatchError(ContainSubstring("no such file or directory"))) + }) + }) + }) + }) + + Describe("AddField", func() { + BeforeEach(func() { + form = formcontent.NewForm() + }) + + It("writes out the provided fields into the multipart form using the writer", func() { + err := form.AddField("key1", "value1") + Expect(err).NotTo(HaveOccurred()) + + err = form.AddField("key2", "value2") + Expect(err).NotTo(HaveOccurred()) + + submission := form.Finalize() + + content, err := ioutil.ReadAll(submission.Content) + Expect(err).NotTo(HaveOccurred()) + + Expect(string(content)).To(MatchRegexp(`^--\w+\r\nContent-Disposition: form-data; name="key1"\r\n\r\nvalue1` + + `\r\n--\w+\r\nContent-Disposition: form-data; name="key2"\r\n\r\nvalue2` + + `\r\n--\w+--\r\n$`)) + }) + }) + + Describe("AddCombined", func() { + var fileWithContent1 string + + BeforeEach(func() { + var err error + + handle1, err := ioutil.TempFile("", "") + Expect(err).NotTo(HaveOccurred()) + + _, err = handle1.WriteString("some content") + Expect(err).NotTo(HaveOccurred()) + + fileWithContent1 = handle1.Name() + + form = formcontent.NewForm() + }) + + AfterEach(func() { + os.Remove(fileWithContent1) + }) + + It("writes out the provided fields into the multipart form using the writer", func() { + err := form.AddField("key1", "value1") + Expect(err).NotTo(HaveOccurred()) + + err = form.AddFile("file1", fileWithContent1) + Expect(err).NotTo(HaveOccurred()) + + submission := form.Finalize() + + content, err := ioutil.ReadAll(submission.Content) + Expect(err).NotTo(HaveOccurred()) + + Expect(submission.ContentLength).To(Equal(int64(373))) + Expect(string(content)).To(MatchRegexp(`^--\w+\r\nContent-Disposition: form-data; name=\"file1\"; filename=\"\w+\"\r\n` + + `Content-Type: application/octet-stream\r\n\r\n` + + `some content` + + `\r\n--\w+\r\nContent-Disposition: form-data; name="key1"\r\n\r\nvalue1` + + `\r\n--\w+--\r\n$`)) + }) + }) + + Describe("Finalize", func() { + var form *formcontent.Form + + BeforeEach(func() { + form = formcontent.NewForm() + }) + + It("returns a content submission which includes the correct length and content type", func() { + err := form.AddField("key1", "value1") + Expect(err).NotTo(HaveOccurred()) + + submission := form.Finalize() + + Expect(submission.ContentLength).To(Equal(int64(185))) + Expect(submission.ContentType).To(ContainSubstring("multipart/form-data")) + }) + + }) +}) diff --git a/main.go b/main.go index 1cda22422..e46f5a32f 100644 --- a/main.go +++ b/main.go @@ -13,11 +13,11 @@ import ( "github.com/olekukonko/tablewriter" "gopkg.in/yaml.v2" - "github.com/fredwangwang/formcontent" "github.com/pivotal-cf/jhanda" "github.com/pivotal-cf/om/api" "github.com/pivotal-cf/om/commands" "github.com/pivotal-cf/om/extractor" + "github.com/pivotal-cf/om/formcontent" "github.com/pivotal-cf/om/network" "github.com/pivotal-cf/om/presenters" "github.com/pivotal-cf/om/progress" diff --git a/vendor/github.com/fredwangwang/formcontent/LICENSE b/vendor/github.com/fredwangwang/formcontent/LICENSE deleted file mode 100644 index 261eeb9e9..000000000 --- a/vendor/github.com/fredwangwang/formcontent/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - 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.