From 17327a87390a5ac875d78104842f06c3481026c9 Mon Sep 17 00:00:00 2001 From: Jim Clark Date: Sun, 4 Dec 2022 12:19:08 -0800 Subject: [PATCH] Initial commit --- .gitignore | 4 + CONTRIBUTING.md | 3 + LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 44 +++++++++++ babashka/ops.go | 88 +++++++++++++++++++++ deps.edn | 3 + dev/user.clj | 20 +++++ docker/ops.go | 98 +++++++++++++++++++++++ go.mod | 18 +++++ go.sum | 26 +++++++ main.go | 30 ++++++++ 11 files changed, 535 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 babashka/ops.go create mode 100644 deps.edn create mode 100644 dev/user.clj create mode 100644 docker/ops.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9220ff2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/parser +/.clj-kondo/ +/.cpcache/ +/.lsp/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5e700c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +Make an [issue](https://github.com/atomisthq/pod-babashka-docker/issues) and/or [PR](https://github.com/atomisthq/pod-babashka-docker/pulls). 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/README.md b/README.md new file mode 100644 index 0000000..38ccf0e --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +## Background + +This is a [babashka pod](https://github.com/babashka/pods) that binds some golang functions into a clojure namespace. Using this pod, clojure programs can parse dockerfiles and docker images names using the "official" docker golang libraries. + +* [`github.com/docker/distribution/reference`](https://github.com/distribution/distribution/blob/main/reference/reference.go) (for image name parsing) +* [`github.com/moby/buildkit/frontend/dockerfile/parser`](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/parser/parser.go) (for generating a Dockerfile AST). + +## Usage + +```clojure +(require '[babashka.pods :as pods]) +(pods/load-pod 'atomisthq/docker "0.1.0") +; OR use a locally built pod binary +#_(pods/load-pod "./parser") + +;; load-pod will create this namespace with two vars +(require '[pod.babashka.docker :as docker]) + +;; parse image names using github.com/docker/distribution +;; turns golang structs into clojure maps +(docker/parse-image-name "gcr.io/whatever:tag") +;; automatically turns golang errors into Exceptions +(try + (docker/parse-image-name "gcr.io/whatever/:tag") + (catch Exception e + ;; invalid reference format + (println (.getMessage e)))) + +;; parse dockerfiles using github.com/moby/buildkit +;; returns the Result struct transformed to a clojure map +(docker/parse-dockerfile "FROM \\\n gcr.io/whatever:tag\nCMD [\"run\"]") +``` + +## Building + +To build the golang `parser` binary locally, run `go build`. + +```bash +go build +``` + +## Contributing + +You can find information about contributing to this project in the CONTRIBUTING.md diff --git a/babashka/ops.go b/babashka/ops.go new file mode 100644 index 0000000..449a76b --- /dev/null +++ b/babashka/ops.go @@ -0,0 +1,88 @@ +package babashka + +import ( + "bufio" + "encoding/json" + "os" + + "github.com/jackpal/bencode-go" +) + +type Message struct { + Op string + Id string + Args string + Var string +} + +type Namespace struct { + Name string "name" + Vars []Var "vars" +} + +type Var struct { + Name string "name" + Code string `bencode:"code,omitempty"` +} + +type DescribeResponse struct { + Format string "format" + Namespaces []Namespace "namespaces" +} + +type InvokeResponse struct { + Id string "id" + Value string "value" // stringified json response + Status []string "status" +} + +type ErrorResponse struct { + Id string "id" + Status []string "status" + ExMessage string "ex-message" + ExData string "ex-data" +} + +func ReadMessage() (*Message, error) { + reader := bufio.NewReader(os.Stdin) + message := &Message{} + if err := bencode.Unmarshal(reader, &message); err != nil { + return nil, err + } + + return message, nil +} + +func WriteDescribeResponse(describeResponse *DescribeResponse) { + writeResponse(*describeResponse) +} + +func WriteInvokeResponse(inputMessage *Message, value any) error { + if value == nil { + return nil + } + resultValue, err := json.Marshal(value) + if err != nil { + return err + } + response := InvokeResponse{Id: inputMessage.Id, Status: []string{"done"}, Value: string(resultValue)} + writeResponse(response) + + return nil +} + +func WriteErrorResponse(inputMessage *Message, err error) { + errorResponse := ErrorResponse{Id: inputMessage.Id, Status: []string{"done", "error"}, ExMessage: err.Error()} + writeResponse(errorResponse) +} + +func writeResponse(response any) error { + writer := bufio.NewWriter(os.Stdout) + if err := bencode.Marshal(writer, response); err != nil { + return err + } + + writer.Flush() + + return nil +} diff --git a/deps.edn b/deps.edn new file mode 100644 index 0000000..5f3945c --- /dev/null +++ b/deps.edn @@ -0,0 +1,3 @@ +{:sources ["dev"] + :deps {babashka/babashka.pods {:mvn/version "0.1.0"} + com.cognitect/transit-clj {:mvn/version "1.0.324"}}} diff --git a/dev/user.clj b/dev/user.clj new file mode 100644 index 0000000..4aefaea --- /dev/null +++ b/dev/user.clj @@ -0,0 +1,20 @@ +(ns user + (:require [babashka.pods :as pods])) + +(pods/load-pod 'atomisthq/docker "0.1.0") +(require '[pod.babashka.docker :as docker]) + +;; parse image names using github.com/docker/distribution +;; turns golang structs into clojure maps +(docker/parse-image-name "gcr.io/whatever:tag") +;; automatically turns golang errors into Exceptions +(try + (docker/parse-image-name "gcr.io/whatever/:tag") + (catch Exception e + ;; invalid reference format + (println (.getMessage e)))) + +;; parse dockerfiles using github.com/moby/buildkit +;; returns the Result struct transformed to a clojure map +(docker/parse-dockerfile "FROM \\\n gcr.io/whatever:tag\nCMD [\"run\"]") + diff --git a/docker/ops.go b/docker/ops.go new file mode 100644 index 0000000..6e6ba75 --- /dev/null +++ b/docker/ops.go @@ -0,0 +1,98 @@ +package docker + +import ( + "github.com/docker/distribution/reference" + "github.com/moby/buildkit/frontend/dockerfile/parser" + + //"reflect" + "crypto/sha256" + "crypto/sha512" + + "encoding/json" + "fmt" + "strings" + + "dockerfileparse/user/parser/babashka" +) + +type Reference struct { + Path string `json:"path"` + Domain string `json:"domain,omitempty"` + Tag string `json:"tag,omitempty"` + Digest string `json:"digest,omitempty"` +} + +type Error struct { + Error string `json:"error"` +} + +func parse_uri(s string) (Reference, error) { + tag, domain, path, digest := "", "", "", "" + + sha256.New() + sha512.New() + + ref, err := reference.Parse(s) + if err != nil { + return Reference{},err; + } + //fmt.Printf("%s\n", reflect.TypeOf(ref)); + + if tagged, ok := ref.(reference.NamedTagged); ok { + tag = tagged.Tag() + } + if named, ok := ref.(reference.Named); ok { + domain = reference.Domain(named) + path = reference.Path(named) + } + if digested, ok := ref.(reference.Canonical); ok { + digest = digested.Digest().String() + } + //u, err := json.Marshal(Reference{Path: path, Domain: domain, Tag: tag, Digest: digest}) + return Reference{Path: path, Domain: domain, Tag: tag, Digest: digest}, err; +} + + +func ProcessMessage(message *babashka.Message) (any, error) { + switch message.Op { + case "describe": + return &babashka.DescribeResponse{ + Format: "json", + Namespaces: []babashka.Namespace{ + { + Name: "pod.babashka.docker", + Vars: []babashka.Var{ + { + Name: "parse-image-name", + }, + { + Name: "parse-dockerfile", + }, + }, + }, + }, + }, nil + case "invoke": + switch message.Var { + case "pod.babashka.docker/parse-image-name": + args := []string{} + if err := json.Unmarshal([]byte(message.Args), &args); err != nil { + return nil, err + } + + return parse_uri(args[0]) + case "pod.babashka.docker/parse-dockerfile": + args := []string{} + if err := json.Unmarshal([]byte(message.Args), &args); err != nil { + return nil, err + } + reader := strings.NewReader(args[0]) + return parser.Parse(reader) + + default: + return nil, fmt.Errorf("Unknown var %s", message.Var) + } + default: + return nil, fmt.Errorf("Unknown op %s", message.Op) + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..6a434ba --- /dev/null +++ b/go.mod @@ -0,0 +1,18 @@ +module dockerfileparse/user/parser + +go 1.19 + +require ( + github.com/docker/distribution v2.8.1+incompatible + github.com/jackpal/bencode-go v1.0.0 + github.com/moby/buildkit v0.10.6 +) + +require ( + github.com/containerd/typeurl v1.0.2 // indirect + github.com/gogo/protobuf v1.3.2 // indirect + github.com/golang/protobuf v1.5.2 // indirect + github.com/opencontainers/go-digest v1.0.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + google.golang.org/protobuf v1.27.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..9acdc60 --- /dev/null +++ b/go.sum @@ -0,0 +1,26 @@ +github.com/containerd/typeurl v1.0.2 h1:Chlt8zIieDbzQFzXzAeBEF92KhExuE4p9p92/QmY7aY= +github.com/containerd/typeurl v1.0.2/go.mod h1:9trJWW2sRlGub4wZJRTW83VtbOLS6hwcDZXTn6oPz9s= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/docker/distribution v2.8.1+incompatible h1:Q50tZOPR6T/hjNsyc9g8/syEs6bk8XXApsHjKukMl68= +github.com/docker/distribution v2.8.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= +github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= +github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/jackpal/bencode-go v1.0.0 h1:lzbSPPqqSfWQnqVNe/BBY1NXdDpncArxShL10+fmFus= +github.com/jackpal/bencode-go v1.0.0/go.mod h1:5FSBQ74yhCl5oQ+QxRPYzWMONFnxbL68/23eezsBI5c= +github.com/moby/buildkit v0.10.6 h1:DJlEuLIgnu34HQKF4n9Eg6q2YqQVC0eOpMb4p2eRS2w= +github.com/moby/buildkit v0.10.6/go.mod h1:tQuuyTWtOb9D+RE425cwOCUkX0/oZ+5iBZ+uWpWQ9bU= +github.com/novln/docker-parser v1.0.0 h1:PjEBd9QnKixcWczNGyEdfUrP6GR0YUilAqG7Wksg3uc= +github.com/novln/docker-parser v1.0.0/go.mod h1:oCeM32fsoUwkwByB5wVjsrsVQySzPWkl3JdlTn1txpE= +github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= +github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= +google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/main.go b/main.go new file mode 100644 index 0000000..d3a0a36 --- /dev/null +++ b/main.go @@ -0,0 +1,30 @@ +package main + +import ( + "dockerfileparse/user/parser/babashka" + "dockerfileparse/user/parser/docker" +) + +func main() { + for { + message, err := babashka.ReadMessage() + if err != nil { + babashka.WriteErrorResponse(message, err) + continue + } + + res, err := docker.ProcessMessage(message) + if err != nil { + babashka.WriteErrorResponse(message, err) + continue + } + + describeres, ok := res.(*babashka.DescribeResponse) + if ok { + babashka.WriteDescribeResponse(describeres) + continue + } + babashka.WriteInvokeResponse(message, res) + } +} +