pod-ilmoraunio-conjtest

A babashka pod for interacting with Clojure/babashka parsers and parsers from conftest using pod-ilmoraunio-conftest.

Usage

(ns my-ns
  (:require [babashka.pods :as pods]))

(pods/load-pod 'ilmoraunio/conjtest "0.1.1")
(require '[pod-ilmoraunio-conjtest.api :as api])

The namespace exposes the following functions:

• parse
• parse-as
• parse-go
• parse-go-as
• parse*
• parse-as*
• parse-go*
• parse-go-as*

Generally, all functions accept either file or glob patterns as argument(s). Passing a directory is also supported, the files directly under the directory will be passed to the parser. Functions ending with * will also accept an optional opts map, which accepts the following options:

field	description
:keywordize?	A boolean flag to determine if output map's keys should be keyworded.

Each function will return a map of filenames to parsed configurations, eg:

{"test-resources/test.yaml"
 {:apiVersion "v1",
  :kind "Service",
  :metadata {:name "hello-kubernetes"},
  :spec
  {:type "LoadBalancer",
   :ports ({:port 80, :targetPort 8080}),
   :selector {:app "hello-kubernetes"}}},

 "test-resources/test.json" {:hello [1 2 4], "@foo" "bar"},

 "test-resources/test.edn" {:foo :bar, :duration "#duration 20m"}}

Generally, Clojure parsers aim to return keyworded maps whereas Go parsers do not.

Currently supported Clojure parsers:

• edn
• json
• yaml

Currently supported Go parsers:

• cue
• dockerfile
• edn
• hcl1
• hcl2
• hocon
• ignore
• ini
• json
• jsonnet
• properties
• spdx
• toml
• vcl
• xml
• yaml
• dotenv

parse

Attempts to parse filenames using either Clojure or Go parsers (in this order, whichever is supported). Will automatically try to determine parser based on filename extension.

(api/parse "test-resources/test.edn")
;; => {"test-resources/test.edn" {:foo :bar, :duration "#duration 20m"}}

(api/parse "test-resources/*.{edn,json}")
;; => {"test-resources/test.json" {:hello [1 2 4], "@foo" "bar"}, "test-resources/test.edn" {:foo :bar, :duration "#duration 20m"}}

(api/parse "test-resources/")
;; => {"test-resources/test.yaml" #ordered/map ([:apiVersion "v1"] [:kind "Service"] [:metadata #ordered/map ([:name "hello-kubernetes"])] [:spec #ordered/map ([:type "LoadBalancer"] [:ports (#ordered/map ([:port 80] [:targetPort 8080]))] [:selector #ordered/map ([:app "hello-kubernetes"])])]), "test-resources/test.yml" #ordered/map ([:apiVersion "v1"] [:kind "Service"] [:metadata #ordered/map ([:name "hello-kubernetes-2"])] [:spec #ordered/map ([:type "LoadBalancer"] [:ports (#ordered/map ([:port 80] [:targetPort 8080]))] [:selector #ordered/map ([:app "hello-kubernetes"])])]), "test-resources/test.json" {:hello [1 2 4], "@foo" "bar"}, "test-resources/test.edn" {:foo :bar, :duration "#duration 20m"}, "test-resources/.dockerignore" [[{"Value" ".idea", "Original" ".idea", "Kind" "Path"} {"Kind" "Empty", "Value" "", "Original" ""}]]}

parse-as

Attempts to parse filenames using parser, either using Clojure or Go parser (in this order, whichever is supported).

(api/parse-as "edn" "test-resources/test.edn")
;; => {"test-resources/test.edn" {:foo :bar, :duration "#duration 20m"}}

(api/parse-as "hocon" "test-resources/hocon/hocon.conf")
;; => {"test-resources/hocon/hocon.conf" {"play" {"editor" "<<unknown value>>", "server" {"debug" {"addDebugInfoToRequests" false}, "dir" "<<unknown value>>", "http" {"address" "0.0.0.0", "idleTimeout" "\"75 seconds\"", "port" 9001.0}, "https" {"address" "0.0.0.0", "engineProvider" "play.core.server.ssl.DefaultSSLEngineProvider", "idleTimeout" "\"75 seconds\"", "keyStore" {"algorithm" "<<unknown value>>", "password" "\"\"", "path" "<<unknown value>>", "type" "JKS"}, "needClientAuth" false, "port" "<<unknown value>>", "trustStore" {"noCaVerification" false}, "wantClientAuth" false}, "pidfile" {"path" "<<unknown value>>"}, "websocket" {"frame" {"maxLength" "64k"}}}}}}

parse-go

Attempts to parse filenames using only Go parsers. Will automatically try to determine parser based on filename extension.

(api/parse-go "test-resources/*{edn,json,yaml,yml,.dockerignore}")
;; => {"test-resources/test.yaml" {"kind" "Service", "metadata" {"name" "hello-kubernetes"}, "spec" {"type" "LoadBalancer", "ports" [{"port" 80.0, "targetPort" 8080.0}], "selector" {"app" "hello-kubernetes"}}, "apiVersion" "v1"}, "test-resources/test.yml" {"apiVersion" "v1", "kind" "Service", "metadata" {"name" "hello-kubernetes-2"}, "spec" {"ports" [{"port" 80.0, "targetPort" 8080.0}], "selector" {"app" "hello-kubernetes"}, "type" "LoadBalancer"}}, "test-resources/test.json" {"hello" [1.0 2.0 4.0], "@foo" "bar"}, "test-resources/.dockerignore" [[{"Kind" "Path", "Value" ".idea", "Original" ".idea"} {"Kind" "Empty", "Value" "", "Original" ""}]], "test-resources/test.edn" {":foo" ":bar", ":duration" "#duration 20m"}}

parse-go-as

Attempts to parse filenames using parser. Uses only Go parsers.

(api/parse-go-as "edn" "test-resources/test.edn")
;; => {"test-resources/test.edn" {":foo" ":bar", ":duration" "#duration 20m"}}

parse*

Attempts to parse filenames using parser and opts. Uses only Go parsers.

(api/parse* {:keywordize? true} "test-resources/test.json")
;; => {"test-resources/test.json" {:hello [1 2 4], "@foo" "bar"}}
(api/parse* {:keywordize? false} "test-resources/test.json") ; explicitly disable keyworded keys
;; => {"test-resources/test.json" {"hello" [1 2 4], "@foo" "bar"}}

parse-as*

Attempts to parse filenames using parser and opts, either using Clojure or Go parser (in this order, whichever is supported).

(api/parse-as* {:keywordize? true} "hcl2" "test-resources/test.hcl2.tf")
;; => {"test-resources/test.hcl2.tf" {:resource {:aws_alb_listener {:my-alb-listener {:port "80", :protocol "HTTP"}},
;;                                    :aws_db_security_group {:my-group {}},
;;                                    :aws_s3_bucket {:valid {:bucket "validBucket",
;;                                                            :tags {:owner "devops", :environment "prod"},
;;                                                            :acl "private"}},
;;                                    :aws_security_group_rule {:my-rule {:cidr_blocks ["0.0.0.0/0"],
;;                                                                        :type "ingress"}},
;;                                    :azurerm_managed_disk {:source {:encryption_settings {:enabled false}}}}}}

parse-go*

Attempts to parse filenames using only Go parsers and opts. Will automatically try to determine parser based on filename extension.

(api/parse-go* {:keywordize? true} "test-resources/test.properties")
;; => {"test-resources/test.properties" {:SAMPLE_VALUE "something-here",
;;                                       :other.value.url "https://example.com/",
;;                                       :secret.value.exception "f9761ebe-d4dc-11eb-8046-1e00e20cdb95"}}

parse-go-as*

Attempts to parse filenames using parser and opts. Uses only Go parsers.

(api/parse-go-as* {:keywordize? true} "vcl" "test-resources/test.vcl")
;; => #_{"test-resources/test.vcl" {:backend {:app {:first_byte_timeout 60.0,
;;                                            :host "127.0.0.1",
;;                                            :max_connections 800.0,
;;                                            :port "8081",
;;                                            :between_bytes_timeout 60.0,
;;                                            :connect_timeout 60.0}},
;;                                  :acl {:purge ["127.0.0.1"]}}}

Development

Build instructions

For building locally on macOS (AArch64)

• Run git submodule update --init --recursive
• Run make build-macos-aarch64

Test instructions

Run ./scripts/test.