Commit a02eee9bc9680ee4751f5371d9e431378a8ed388 - kitchensink-clojure

(MAINT) change error format, bump to 2.0.0 This commit changes the kitchensink slingshot error maps to use the format that is more commonly used in the other PL clojure projects, replacing `:type` and `:message` with `:kind` and `:msg`. It also bumps the version number up to 2.0.0, because, technically, this is an API-breaking change :/ Chris Price 7 years ago

3 changed file(s) with 57 addition(s) and 54 deletion(s). Raw diff Collapse all Expand all

-1

project.clj less more

0		(defproject puppetlabs/kitchensink "1.4.1-SNAPSHOT"
	0	(defproject puppetlabs/kitchensink "2.0.0-SNAPSHOT"
1	1	:description "Clojure utility functions"
2	2	:license {:name "Apache License, Version 2.0"
3	3	:url "http://www.apache.org/licenses/LICENSE-2.0.html"}

+25

-22

src/puppetlabs/kitchensink/core.clj less more

24	24	[clj-time.coerce :only [ICoerce to-date-time]]
25	25	[clj-time.format :only [formatters unparse]]))
26	26
	27
	28	(defn error-map
	29	[kind message]
	30	{:kind kind
	31	:msg message})
	32
27	33	;; ## Type checking
28	34
29	35	(defn array?

69	75	(condp = (.toLowerCase s)
70	76	"true" true
71	77	"false" false
72		(throw+ {:type ::parse-error
73		:message (format "Unable to parse '%s' to a boolean" s)})))
	78	(throw+ (error-map ::parse-error
	79	(format "Unable to parse '%s' to a boolean" s)))))
74	80
75	81	(defn parse-bool
76	82	"Parse a string and return its boolean value."

161	167
162	168	The slingshot exception will look like this:
163	169
164		`{:type :puppetlabs.kitchensink.core/io-error
165		:message \"Parent directory '/foo/bar' is not writable\"}`"
	170	`{:kind :puppetlabs.kitchensink.core/io-error
	171	:msg \"Parent directory '/foo/bar' is not writable\"}`"
166	172	[path]
167	173	{:pre [((some-fn #(instance? File %) string?) path)]
168	174	:post [(fs/directory? path)]}
169	175	(let [path-as-file (fs/file path)]
170	176	(if (fs/file? path-as-file)
171		(throw+ {:type ::io-error
172		:message (format "Path '%s' is a file" path)})
	177	(throw+ (error-map ::io-error
	178	(format "Path '%s' is a file" path)))
173	179	(doseq [^File dir (reverse (cons path-as-file (fs/parents path-as-file)))]
174	180	(when-not (fs/exists? dir)
175	181	(let [parent (.getParentFile dir)]
176	182	(when (fs/file? parent)
177		(throw+ {:type ::io-error
178		:message (format "Parent directory '%s' is a file"
179		parent)}))
	183	(throw+ (error-map ::io-error
	184	(format "Parent directory '%s' is a file"
	185	parent))))
180	186
181	187	(when-not (.canWrite parent)
182		(throw+ {:type ::io-error
183		:message (format "Parent directory '%s' is not writable"
184		parent)}))
	188	(throw+ (error-map ::io-error
	189	(format "Parent directory '%s' is not writable"
	190	parent))))
185	191
186	192	(let [success (.mkdir dir)]
187	193	(when-not success
188		(throw+ {:type ::io-error
189		:message (format "Unable to create directory '%s'"
190		parent)})))))))))
	194	(throw+ (error-map ::io-error
	195	(format "Unable to create directory '%s'"
	196	parent)))))))))))
191	197
192	198	;; ## Math
193	199

804	810	the program to exit and display the help message.
805	811
806	812	** The map is thrown using 'slingshot' (https://github.com/scgilardi/slingshot).
807		It contains a `:type` and `:message`, where type is either `:error` or `:help`,
	813	It contains a `:kind` and `:msg`, where type is either `:error` or `:help`,
808	814	and the message is either the error message or a help banner.
809	815
810	816	Returns a three-item vector, containing:

824	830	(apply str errors)
825	831	"\n\n"
826	832	summary)]
827		(throw+ {:type ::cli-error
828		:message msg})))
	833	(throw+ (error-map ::cli-error msg))))
829	834	(when (:help options)
830		(throw+ {:type ::cli-help
831		:message summary}))
	835	(throw+ (error-map ::cli-help summary)))
832	836	(when-let [missing-field (some #(if (not (contains? options %)) %) required-args)]
833	837	(let [msg (str
834	838	"\n\n"
835	839	(format "Missing required argument '--%s'!" (name missing-field))
836	840	"\n\n"
837	841	summary)]
838		(throw+ {:type ::cli-error
839		:message msg})))
	842	(throw+ (error-map ::cli-error msg))))
840	843	[options arguments summary])))
841	844
842	845

+31

-31

test/puppetlabs/kitchensink/core_test.clj less more

80	80	(to-bool "hi")
81	81	(is (not true) "Expected exception to be thrown by to-bool when an invalid string is passed")
82	82	(catch map? m
83		(is (contains? m :type))
84		(is (= :puppetlabs.kitchensink.core/parse-error (:type m)))
85		(is (= :parse-error (without-ns (:type m))))
86		(is (contains? m :message))
87		(is (re-find #"Unable to parse 'hi' to a boolean" (:message m)))))))
	83	(is (contains? m :kind))
	84	(is (= :puppetlabs.kitchensink.core/parse-error (:kind m)))
	85	(is (= :parse-error (without-ns (:kind m))))
	86	(is (contains? m :msg))
	87	(is (re-find #"Unable to parse 'hi' to a boolean" (:msg m)))))))
88	88
89	89	(deftest test-true-str?
90	90	(are [t-or-f? str-val] (t-or-f? (true-str? str-val))

124	124	(mkdirs! (fs/file tmpdir "foo" "bar" "baz"))
125	125	(is (not true) "Expected exception to be thrown by mkdirs! when one of the elements of the path already exists and is a file")
126	126	(catch map? m
127		(is (contains? m :type))
128		(is (= :puppetlabs.kitchensink.core/io-error (:type m)))
129		(is (= :io-error (without-ns (:type m))))
130		(is (contains? m :message))
131		(is (re-find #"foo/bar' is a file" (:message m)))))))
	127	(is (contains? m :kind))
	128	(is (= :puppetlabs.kitchensink.core/io-error (:kind m)))
	129	(is (= :io-error (without-ns (:kind m))))
	130	(is (contains? m :msg))
	131	(is (re-find #"foo/bar' is a file" (:msg m)))))))
132	132	(testing "throws exception if the path exists and is a file"
133	133	(let [tmpdir (temp-dir)]
134	134	(fs/mkdirs (fs/file tmpdir "foo"))

138	138	(is (not true) (str "Expected exception to be thrown by mkdirs! when "
139	139	"the path already exists and is a file"))
140	140	(catch map? m
141		(is (contains? m :type))
142		(is (= :puppetlabs.kitchensink.core/io-error (:type m)))
143		(is (= :io-error (without-ns (:type m))))
144		(is (contains? m :message))
145		(is (re-find #"foo/bar' is a file" (:message m)))))))
	141	(is (contains? m :kind))
	142	(is (= :puppetlabs.kitchensink.core/io-error (:kind m)))
	143	(is (= :io-error (without-ns (:kind m))))
	144	(is (contains? m :msg))
	145	(is (re-find #"foo/bar' is a file" (:msg m)))))))
146	146	(testing "Permission denied on some directory in the hierarchy"
147	147	(let [tmpdir (temp-dir)]
148	148	(fs/mkdirs (fs/file tmpdir "foo"))

151	151	(mkdirs! (fs/file tmpdir "foo" "bar" "baz"))
152	152	(is (not true) "Expected exception to be thrown by mkdirs! when a permissions error occurs")
153	153	(catch map? m
154		(is (contains? m :type))
155		(is (= :puppetlabs.kitchensink.core/io-error (:type m)))
156		(is (= :io-error (without-ns (:type m))))
157		(is (contains? m :message))
158		(is (re-find #"foo' is not writable" (:message m))))))))
	154	(is (contains? m :kind))
	155	(is (= :puppetlabs.kitchensink.core/io-error (:kind m)))
	156	(is (= :io-error (without-ns (:kind m))))
	157	(is (contains? m :msg))
	158	(is (re-find #"foo' is not writable" (:msg m))))))))
159	159
160	160	(deftest quotient-test
161	161	(testing "quotient"

466	466	(try+
467	467	(cli! [] [["-r" "--required" "A required field"]] [:required])
468	468	(catch map? m
469		(is (contains? m :type))
470		(is (= :puppetlabs.kitchensink.core/cli-error (:type m)))
471		(is (= :cli-error (without-ns (:type m))))
472		(is (contains? m :message))
	469	(is (contains? m :kind))
	470	(is (= :puppetlabs.kitchensink.core/cli-error (:kind m)))
	471	(is (= :cli-error (without-ns (:kind m))))
	472	(is (contains? m :msg))
473	473	(reset! got-expected-error true)))
474	474	(is (true? @got-expected-error))))
475	475

478	478	(try+
479	479	(cli! ["--help"] [] [])
480	480	(catch map? m
481		(is (contains? m :type))
482		(is (= :puppetlabs.kitchensink.core/cli-help (:type m)))
483		(is (= :cli-help (without-ns (:type m))))
484		(is (contains? m :message))
	481	(is (contains? m :kind))
	482	(is (= :puppetlabs.kitchensink.core/cli-help (:kind m)))
	483	(is (= :cli-help (without-ns (:kind m))))
	484	(is (contains? m :msg))
485	485	(reset! got-expected-help true)))
486	486	(is (true? @got-expected-help))))
487	487

509	509	args ["--bar"]]
510	510	(cli! args specs))
511	511	(catch map? m
512		(is (= :puppetlabs.kitchensink.core/cli-error (:type m)))
513		(is (contains? m :message))
	512	(is (= :puppetlabs.kitchensink.core/cli-error (:kind m)))
	513	(is (contains? m :msg))
514	514	(is (re-find
515	515	#"Unknown option.*--bar"
516		(m :message)))
	516	(m :msg)))
517	517	(reset! got-expected-exception true)))
518	518	(is (true? @got-expected-exception)))))
519	519