Fundamental library of the Clojure language
Fundamental library of the Clojure language
Graphical object inspector for Clojure data structures.
Graphical object inspector for Clojure data structures.
This file defines polymorphic I/O utility functions for Clojure.
This file defines polymorphic I/O utility functions for Clojure.
Top-level main function for Clojure REPL and scripts.
Top-level main function for Clojure REPL and scripts.
A Pretty Printer for Clojure
clojure.pprint implements a flexible system for printing structured data in a pleasing, easy-to-understand format. Basic use of the pretty printer is simple, just call pprint instead of println. More advanced users can use the building blocks provided to create custom output formats.
Out of the box, pprint supports a simple structured format for basic data and a specialized format for Clojure source code. More advanced formats, including formats that don't look like Clojure data at all like XML and JSON, can be rendered by creating custom dispatch functions.
In addition to the pprint function, this module contains cl-format, a text formatting function which is fully compatible with the format function in Common Lisp. Because pretty printing directives are directly integrated with cl-format, it supports very concise custom dispatch. It also provides a more powerful alternative to Clojure's standard format function.
See documentation for pprint and cl-format for more information or complete documentation on the Clojure web site on GitHub.
A Pretty Printer for Clojure clojure.pprint implements a flexible system for printing structured data in a pleasing, easy-to-understand format. Basic use of the pretty printer is simple, just call pprint instead of println. More advanced users can use the building blocks provided to create custom output formats. Out of the box, pprint supports a simple structured format for basic data and a specialized format for Clojure source code. More advanced formats, including formats that don't look like Clojure data at all like XML and JSON, can be rendered by creating custom dispatch functions. In addition to the pprint function, this module contains cl-format, a text formatting function which is fully compatible with the format function in Common Lisp. Because pretty printing directives are directly integrated with cl-format, it supports very concise custom dispatch. It also provides a more powerful alternative to Clojure's standard format function. See documentation for pprint and cl-format for more information or complete documentation on the Clojure web site on GitHub.
Utilities meant to be used interactively at the REPL
Utilities meant to be used interactively at the REPL
Set operations such as union/intersection.
Set operations such as union/intersection.
Print stack traces oriented towards Clojure, not Java.
Print stack traces oriented towards Clojure, not Java.
Macros that expand to repeated copies of a template expression.
Macros that expand to repeated copies of a template expression.
A unit testing framework.
ASSERTIONS
The core of the library is the "is" macro, which lets you make assertions of any arbitrary expression:
(is (= 4 (+ 2 2))) (is (instance? Integer 256)) (is (.startsWith "abcde" "ab"))
You can type an "is" expression directly at the REPL, which will print a message if it fails.
user> (is (= 5 (+ 2 2)))
FAIL in (:1)
expected: (= 5 (+ 2 2))
actual: (not (= 5 4))
false
The "expected:" line shows you the original expression, and the "actual:" shows you what actually happened. In this case, it shows that (+ 2 2) returned 4, which is not = to 5. Finally, the "false" on the last line is the value returned from the expression. The "is" macro always returns the result of the inner expression.
There are two special assertions for testing exceptions. The "(is (thrown? c ...))" form tests if an exception of class c is thrown:
(is (thrown? ArithmeticException (/ 1 0)))
"(is (thrown-with-msg? c re ...))" does the same thing and also tests that the message on the exception matches the regular expression re:
(is (thrown-with-msg? ArithmeticException #"Divide by zero" (/ 1 0)))
DOCUMENTING TESTS
"is" takes an optional second argument, a string describing the assertion. This message will be included in the error report.
(is (= 5 (+ 2 2)) "Crazy arithmetic")
In addition, you can document groups of assertions with the "testing" macro, which takes a string followed by any number of assertions. The string will be included in failure reports. Calls to "testing" may be nested, and all of the strings will be joined together with spaces in the final report, in a style similar to RSpec http://rspec.info/
(testing "Arithmetic" (testing "with positive integers" (is (= 4 (+ 2 2))) (is (= 7 (+ 3 4)))) (testing "with negative integers" (is (= -4 (+ -2 -2))) (is (= -1 (+ 3 -4)))))
Note that, unlike RSpec, the "testing" macro may only be used INSIDE a "deftest" or "with-test" form (see below).
DEFINING TESTS
There are two ways to define tests. The "with-test" macro takes a defn or def form as its first argument, followed by any number of assertions. The tests will be stored as metadata on the definition.
(with-test (defn my-function [x y] (+ x y)) (is (= 4 (my-function 2 2))) (is (= 7 (my-function 3 4))))
As of Clojure SVN rev. 1221, this does not work with defmacro. See http://code.google.com/p/clojure/issues/detail?id=51
The other way lets you define tests separately from the rest of your code, even in a different namespace:
(deftest addition (is (= 4 (+ 2 2))) (is (= 7 (+ 3 4))))
(deftest subtraction (is (= 1 (- 4 3))) (is (= 3 (- 7 4))))
This creates functions named "addition" and "subtraction", which can be called like any other function. Therefore, tests can be grouped and composed, in a style similar to the test framework in Peter Seibel's "Practical Common Lisp" http://www.gigamonkeys.com/book/practical-building-a-unit-test-framework.html
(deftest arithmetic (addition) (subtraction))
The names of the nested tests will be joined in a list, like "(arithmetic addition)", in failure reports. You can use nested tests to set up a context shared by several tests.
RUNNING TESTS
Run tests with the function "(run-tests namespaces...)":
(run-tests 'your.namespace 'some.other.namespace)
If you don't specify any namespaces, the current namespace is used. To run all tests in all namespaces, use "(run-all-tests)".
By default, these functions will search for all tests defined in a namespace and run them in an undefined order. However, if you are composing tests, as in the "arithmetic" example above, you probably do not want the "addition" and "subtraction" tests run separately. In that case, you must define a special function named "test-ns-hook" that runs your tests in the correct order:
(defn test-ns-hook [] (arithmetic))
Note: test-ns-hook prevents execution of fixtures (see below).
OMITTING TESTS FROM PRODUCTION CODE
You can bind the variable "load-tests" to false when loading or compiling code in production. This will prevent any tests from being created by "with-test" or "deftest".
FIXTURES
Fixtures allow you to run code before and after tests, to set up the context in which tests should be run.
A fixture is just a function that calls another function passed as an argument. It looks like this:
(defn my-fixture [f] Perform setup, establish bindings, whatever. (f) Then call the function we were passed. Tear-down / clean-up code here. )
Fixtures are attached to namespaces in one of two ways. "each" fixtures are run repeatedly, once for each test function created with "deftest" or "with-test". "each" fixtures are useful for establishing a consistent before/after state for each test, like clearing out database tables.
"each" fixtures can be attached to the current namespace like this: (use-fixtures :each fixture1 fixture2 ...) The fixture1, fixture2 are just functions like the example above. They can also be anonymous functions, like this: (use-fixtures :each (fn [f] setup... (f) cleanup...))
The other kind of fixture, a "once" fixture, is only run once, around ALL the tests in the namespace. "once" fixtures are useful for tasks that only need to be performed once, like establishing database connections, or for time-consuming tasks.
Attach "once" fixtures to the current namespace like this: (use-fixtures :once fixture1 fixture2 ...)
Note: Fixtures and test-ns-hook are mutually incompatible. If you are using test-ns-hook, fixture functions will never be run.
SAVING TEST OUTPUT TO A FILE
All the test reporting functions write to the var test-out. By default, this is the same as out, but you can rebind it to any PrintWriter. For example, it could be a file opened with clojure.java.io/writer.
EXTENDING TEST-IS (ADVANCED)
You can extend the behavior of the "is" macro by defining new methods for the "assert-expr" multimethod. These methods are called during expansion of the "is" macro, so they should return quoted forms to be evaluated.
You can plug in your own test-reporting framework by rebinding the "report" function: (report event)
The 'event' argument is a map. It will always have a :type key, whose value will be a keyword signaling the type of event being reported. Standard events with :type value of :pass, :fail, and :error are called when an assertion passes, fails, and throws an exception, respectively. In that case, the event will also have the following keys:
:expected The form that was expected to be true :actual A form representing what actually occurred :message The string message given as an argument to 'is'
The "testing" strings will be a list in "testing-contexts", and the vars being tested will be a list in "testing-vars".
Your "report" function should wrap any printing calls in the "with-test-out" macro, which rebinds out to the current value of test-out.
For additional event types, see the examples in the code.
A unit testing framework. ASSERTIONS The core of the library is the "is" macro, which lets you make assertions of any arbitrary expression: (is (= 4 (+ 2 2))) (is (instance? Integer 256)) (is (.startsWith "abcde" "ab")) You can type an "is" expression directly at the REPL, which will print a message if it fails. user> (is (= 5 (+ 2 2))) FAIL in (:1) expected: (= 5 (+ 2 2)) actual: (not (= 5 4)) false The "expected:" line shows you the original expression, and the "actual:" shows you what actually happened. In this case, it shows that (+ 2 2) returned 4, which is not = to 5. Finally, the "false" on the last line is the value returned from the expression. The "is" macro always returns the result of the inner expression. There are two special assertions for testing exceptions. The "(is (thrown? c ...))" form tests if an exception of class c is thrown: (is (thrown? ArithmeticException (/ 1 0))) "(is (thrown-with-msg? c re ...))" does the same thing and also tests that the message on the exception matches the regular expression re: (is (thrown-with-msg? ArithmeticException #"Divide by zero" (/ 1 0))) DOCUMENTING TESTS "is" takes an optional second argument, a string describing the assertion. This message will be included in the error report. (is (= 5 (+ 2 2)) "Crazy arithmetic") In addition, you can document groups of assertions with the "testing" macro, which takes a string followed by any number of assertions. The string will be included in failure reports. Calls to "testing" may be nested, and all of the strings will be joined together with spaces in the final report, in a style similar to RSpec <http://rspec.info/> (testing "Arithmetic" (testing "with positive integers" (is (= 4 (+ 2 2))) (is (= 7 (+ 3 4)))) (testing "with negative integers" (is (= -4 (+ -2 -2))) (is (= -1 (+ 3 -4))))) Note that, unlike RSpec, the "testing" macro may only be used INSIDE a "deftest" or "with-test" form (see below). DEFINING TESTS There are two ways to define tests. The "with-test" macro takes a defn or def form as its first argument, followed by any number of assertions. The tests will be stored as metadata on the definition. (with-test (defn my-function [x y] (+ x y)) (is (= 4 (my-function 2 2))) (is (= 7 (my-function 3 4)))) As of Clojure SVN rev. 1221, this does not work with defmacro. See http://code.google.com/p/clojure/issues/detail?id=51 The other way lets you define tests separately from the rest of your code, even in a different namespace: (deftest addition (is (= 4 (+ 2 2))) (is (= 7 (+ 3 4)))) (deftest subtraction (is (= 1 (- 4 3))) (is (= 3 (- 7 4)))) This creates functions named "addition" and "subtraction", which can be called like any other function. Therefore, tests can be grouped and composed, in a style similar to the test framework in Peter Seibel's "Practical Common Lisp" <http://www.gigamonkeys.com/book/practical-building-a-unit-test-framework.html> (deftest arithmetic (addition) (subtraction)) The names of the nested tests will be joined in a list, like "(arithmetic addition)", in failure reports. You can use nested tests to set up a context shared by several tests. RUNNING TESTS Run tests with the function "(run-tests namespaces...)": (run-tests 'your.namespace 'some.other.namespace) If you don't specify any namespaces, the current namespace is used. To run all tests in all namespaces, use "(run-all-tests)". By default, these functions will search for all tests defined in a namespace and run them in an undefined order. However, if you are composing tests, as in the "arithmetic" example above, you probably do not want the "addition" and "subtraction" tests run separately. In that case, you must define a special function named "test-ns-hook" that runs your tests in the correct order: (defn test-ns-hook [] (arithmetic)) Note: test-ns-hook prevents execution of fixtures (see below). OMITTING TESTS FROM PRODUCTION CODE You can bind the variable "*load-tests*" to false when loading or compiling code in production. This will prevent any tests from being created by "with-test" or "deftest". FIXTURES Fixtures allow you to run code before and after tests, to set up the context in which tests should be run. A fixture is just a function that calls another function passed as an argument. It looks like this: (defn my-fixture [f] Perform setup, establish bindings, whatever. (f) Then call the function we were passed. Tear-down / clean-up code here. ) Fixtures are attached to namespaces in one of two ways. "each" fixtures are run repeatedly, once for each test function created with "deftest" or "with-test". "each" fixtures are useful for establishing a consistent before/after state for each test, like clearing out database tables. "each" fixtures can be attached to the current namespace like this: (use-fixtures :each fixture1 fixture2 ...) The fixture1, fixture2 are just functions like the example above. They can also be anonymous functions, like this: (use-fixtures :each (fn [f] setup... (f) cleanup...)) The other kind of fixture, a "once" fixture, is only run once, around ALL the tests in the namespace. "once" fixtures are useful for tasks that only need to be performed once, like establishing database connections, or for time-consuming tasks. Attach "once" fixtures to the current namespace like this: (use-fixtures :once fixture1 fixture2 ...) Note: Fixtures and test-ns-hook are mutually incompatible. If you are using test-ns-hook, fixture functions will *never* be run. SAVING TEST OUTPUT TO A FILE All the test reporting functions write to the var *test-out*. By default, this is the same as *out*, but you can rebind it to any PrintWriter. For example, it could be a file opened with clojure.java.io/writer. EXTENDING TEST-IS (ADVANCED) You can extend the behavior of the "is" macro by defining new methods for the "assert-expr" multimethod. These methods are called during expansion of the "is" macro, so they should return quoted forms to be evaluated. You can plug in your own test-reporting framework by rebinding the "report" function: (report event) The 'event' argument is a map. It will always have a :type key, whose value will be a keyword signaling the type of event being reported. Standard events with :type value of :pass, :fail, and :error are called when an assertion passes, fails, and throws an exception, respectively. In that case, the event will also have the following keys: :expected The form that was expected to be true :actual A form representing what actually occurred :message The string message given as an argument to 'is' The "testing" strings will be a list in "*testing-contexts*", and the vars being tested will be a list in "*testing-vars*". Your "report" function should wrap any printing calls in the "with-test-out" macro, which rebinds *out* to the current value of *test-out*. For additional event types, see the examples in the code.
clojure.test extension for JUnit-compatible XML output.
JUnit (http://junit.org/) is the most popular unit-testing library for Java. As such, tool support for JUnit output formats is common. By producing compatible output from tests, this tool support can be exploited.
To use, wrap any calls to clojure.test/run-tests in the with-junit-output macro, like this:
(use 'clojure.test) (use 'clojure.test.junit)
(with-junit-output (run-tests 'my.cool.library))
To write the output to a file, rebind clojure.test/test-out to your own PrintWriter (perhaps opened using clojure.java.io/writer).
clojure.test extension for JUnit-compatible XML output. JUnit (http://junit.org/) is the most popular unit-testing library for Java. As such, tool support for JUnit output formats is common. By producing compatible output from tests, this tool support can be exploited. To use, wrap any calls to clojure.test/run-tests in the with-junit-output macro, like this: (use 'clojure.test) (use 'clojure.test.junit) (with-junit-output (run-tests 'my.cool.library)) To write the output to a file, rebind clojure.test/*test-out* to your own PrintWriter (perhaps opened using clojure.java.io/writer).
clojure.test extensions for the Test Anything Protocol (TAP)
TAP is a simple text-based syntax for reporting test results. TAP was originally developed for Perl, and now has implementations in several languages. For more information on TAP, see http://testanything.org/ and http://search.cpan.org/~petdance/TAP-1.0.0/TAP.pm
To use this library, wrap any calls to clojure.test/run-tests in the with-tap-output macro, like this:
(use 'clojure.test) (use 'clojure.test.tap)
(with-tap-output (run-tests 'my.cool.library))
clojure.test extensions for the Test Anything Protocol (TAP) TAP is a simple text-based syntax for reporting test results. TAP was originally developed for Perl, and now has implementations in several languages. For more information on TAP, see http://testanything.org/ and http://search.cpan.org/~petdance/TAP-1.0.0/TAP.pm To use this library, wrap any calls to clojure.test/run-tests in the with-tap-output macro, like this: (use 'clojure.test) (use 'clojure.test.tap) (with-tap-output (run-tests 'my.cool.library))
This file defines a generic tree walker for Clojure data structures. It takes any data structure (list, vector, map, set, seq), calls a function on every element, and uses the return value of the function in place of the original. This makes it fairly easy to write recursive search-and-replace functions, as shown in the examples.
Note: "walk" supports all Clojure data structures EXCEPT maps created with sorted-map-by. There is no (obvious) way to retrieve the sorting function.
This file defines a generic tree walker for Clojure data structures. It takes any data structure (list, vector, map, set, seq), calls a function on every element, and uses the return value of the function in place of the original. This makes it fairly easy to write recursive search-and-replace functions, as shown in the examples. Note: "walk" supports all Clojure data structures EXCEPT maps created with sorted-map-by. There is no (obvious) way to retrieve the sorting function.
XML reading/writing.
XML reading/writing.
Functional hierarchical zipper, with navigation, editing, and enumeration. See Huet
Functional hierarchical zipper, with navigation, editing, and enumeration. See Huet
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close