summaryrefslogtreecommitdiff
path: root/tests/unity/docs
diff options
context:
space:
mode:
authorhathach <[email protected]>2012-12-18 15:08:30 +0700
committerhathach <[email protected]>2012-12-18 15:08:30 +0700
commitec4a3f60488fbd9eaf51c12b1cce79f0a7d3064f (patch)
tree99d3f27558811ef6a5554e45d3c2cfd062e90893 /tests/unity/docs
parent50c89192d83ab96c894fd88a9d1ca2887ad43fec (diff)
cleaning
Diffstat (limited to 'tests/unity/docs')
-rw-r--r--tests/unity/docs/Unity Summary.odtbin122486 -> 0 bytes
-rw-r--r--tests/unity/docs/Unity Summary.pdfbin218553 -> 0 bytes
-rw-r--r--tests/unity/docs/Unity Summary.txt216
-rw-r--r--tests/unity/docs/license.txt31
4 files changed, 0 insertions, 247 deletions
diff --git a/tests/unity/docs/Unity Summary.odt b/tests/unity/docs/Unity Summary.odt
deleted file mode 100644
index 653086459..000000000
--- a/tests/unity/docs/Unity Summary.odt
+++ /dev/null
Binary files differ
diff --git a/tests/unity/docs/Unity Summary.pdf b/tests/unity/docs/Unity Summary.pdf
deleted file mode 100644
index b1e641987..000000000
--- a/tests/unity/docs/Unity Summary.pdf
+++ /dev/null
Binary files differ
diff --git a/tests/unity/docs/Unity Summary.txt b/tests/unity/docs/Unity Summary.txt
deleted file mode 100644
index 8b79f087f..000000000
--- a/tests/unity/docs/Unity Summary.txt
+++ /dev/null
@@ -1,216 +0,0 @@
-==============
-Unity Test API
-==============
-
-[Copyright (c) 2007 - 2012 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams]
-
--------------
-Running Tests
--------------
-
-RUN_TEST(func, linenum)
-
-Each Test is run within the macro RUN_TEST. This macro performs necessary setup before the test is called and handles cleanup and result tabulation afterwards.
-
---------------
-Ignoring Tests
---------------
-
-There are times when a test is incomplete or not valid for some reason. At these times, TEST_IGNORE can be called. Control will immediately be returned to the caller of the test, and no failures will be returned.
-
-TEST_IGNORE()
-
-Ignore this test and return immediately
-
-TEST_IGNORE_MESSAGE (message)
-
-Ignore this test and return immediately. Output a message stating why the test was ignored.
-
---------------
-Aborting Tests
---------------
-
-There are times when a test will contain an infinite loop on error conditions, or there may be reason to escape from the test early without executing the rest of the test. A pair of macros support this functionality in Unity. The first (TEST_PROTECT) sets up the feature, and handles emergency abort cases. TEST_ABORT can then be used at any time within the tests to return to the last TEST_PROTECT call.
-
-TEST_PROTECT()
-
-Setup and Catch macro
-
-TEST_ABORT()
-
-Abort Test macro
-
-Example:
-
-main()
-{
- if (TEST_PROTECT() == 0)
- {
- MyTest();
- }
-}
-
-If MyTest calls TEST_ABORT, program control will immediately return to TEST_PROTECT with a non-zero return value.
-
-
-=======================
-Unity Assertion Summary
-=======================
-
---------------------
-Basic Validity Tests
---------------------
-
-TEST_ASSERT_TRUE(condition)
-
-Evaluates whatever code is in condition and fails if it evaluates to false
-
-TEST_ASSERT_FALSE(condition)
-
-Evaluates whatever code is in condition and fails if it evaluates to true
-
-TEST_ASSERT(condition)
-
-Another way of calling TEST_ASSERT_TRUE
-
-TEST_ASSERT_UNLESS(condition)
-
-Another way of calling TEST_ASSERT_FALSE
-
-TEST_FAIL()
-TEST_FAIL_MESSAGE(message)
-
-This test is automatically marked as a failure. The message is output stating why.
-
-------------------------------
-Numerical Assertions: Integers
-------------------------------
-
-TEST_ASSERT_EQUAL_INT(expected, actual)
-TEST_ASSERT_EQUAL_INT8(expected, actual)
-TEST_ASSERT_EQUAL_INT16(expected, actual)
-TEST_ASSERT_EQUAL_INT32(expected, actual)
-TEST_ASSERT_EQUAL_INT64(expected, actual)
-
-Compare two integers for equality and display errors as signed integers. A cast will be performed
-to your natural integer size so often this can just be used. When you need to specify the exact size,
-like when comparing arrays, you can use a specific version:
-
-TEST_ASSERT_EQUAL_UINT(expected, actual)
-TEST_ASSERT_EQUAL_UINT8(expected, actual)
-TEST_ASSERT_EQUAL_UINT16(expected, actual)
-TEST_ASSERT_EQUAL_UINT32(expected, actual)
-TEST_ASSERT_EQUAL_UINT64(expected, actual)
-
-Compare two integers for equality and display errors as unsigned integers. Like INT, there are
-variants for different sizes also.
-
-TEST_ASSERT_EQUAL_HEX(expected, actual)
-TEST_ASSERT_EQUAL_HEX8(expected, actual)
-TEST_ASSERT_EQUAL_HEX16(expected, actual)
-TEST_ASSERT_EQUAL_HEX32(expected, actual)
-TEST_ASSERT_EQUAL_HEX64(expected, actual)
-
-Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons,
-you can specify the size... here the size will also effect how many nibbles are shown (for example, HEX16
-will show 4 nibbles).
-
-_ARRAY
-
-You can append _ARRAY to any of these macros to make an array comparison of that type. Here you will
-need to care a bit more about the actual size of the value being checked. You will also specify an
-additional argument which is the number of elements to compare. For example:
-
-TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, elements)
-
-TEST_ASSERT_EQUAL(expected, actual)
-
-Another way of calling TEST_ASSERT_EQUAL_INT
-
-TEST_ASSERT_INT_WITHIN(delta, expected, actual)
-
-Asserts that the actual value is within plus or minus delta of the expected value. This also comes in
-size specific variants.
-
-
------------------------------
-Numerical Assertions: Bitwise
------------------------------
-
-TEST_ASSERT_BITS(mask, expected, actual)
-
-Use an integer mask to specify which bits should be compared between two other integers. High bits in the mask are compared, low bits ignored.
-
-TEST_ASSERT_BITS_HIGH(mask, actual)
-
-Use an integer mask to specify which bits should be inspected to determine if they are all set high. High bits in the mask are compared, low bits ignored.
-
-TEST_ASSERT_BITS_LOW(mask, actual)
-
-Use an integer mask to specify which bits should be inspected to determine if they are all set low. High bits in the mask are compared, low bits ignored.
-
-TEST_ASSERT_BIT_HIGH(bit, actual)
-
-Test a single bit and verify that it is high. The bit is specified 0-31 for a 32-bit integer.
-
-TEST_ASSERT_BIT_LOW(bit, actual)
-
-Test a single bit and verify that it is low. The bit is specified 0-31 for a 32-bit integer.
-
-----------------------------
-Numerical Assertions: Floats
-----------------------------
-
-TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual)
-
-Asserts that the actual value is within plus or minus delta of the expected value.
-
-TEST_ASSERT_EQUAL_FLOAT(expected, actual)
-TEST_ASSERT_EQUAL_DOUBLE(expected, actual)
-
-Asserts that two floating point values are "equal" within a small % delta of the expected value.
-
------------------
-String Assertions
------------------
-
-TEST_ASSERT_EQUAL_STRING(expected, actual)
-
-Compare two null-terminate strings. Fail if any character is different or if the lengths are different.
-
-TEST_ASSERT_EQUAL_STRING_MESSAGE(expected, actual, message)
-
-Compare two null-terminate strings. Fail if any character is different or if the lengths are different. Output a custom message on failure.
-
-------------------
-Pointer Assertions
-------------------
-
-Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity.
-
-TEST_ASSERT_NULL(pointer)
-
-Fails if the pointer is not equal to NULL
-
-TEST_ASSERT_NOT_NULL(pointer)
-
-Fails if the pointer is equal to NULL
-
-
------------------
-Memory Assertions
------------------
-
-TEST_ASSERT_EQUAL_MEMORY(expected, actual, len)
-
-Compare two blocks of memory. This is a good generic assertion for types that can't be coerced into acting like
-standard types... but since it's a memory compare, you have to be careful that your data types are packed.
-
---------
-_MESSAGE
---------
-
-you can append _MESSAGE to any of the macros to make them take an additional argument. This argument
-is a string that will be printed at the end of the failure strings. This is useful for specifying more
-information about the problem.
-
diff --git a/tests/unity/docs/license.txt b/tests/unity/docs/license.txt
deleted file mode 100644
index c42e33014..000000000
--- a/tests/unity/docs/license.txt
+++ /dev/null
@@ -1,31 +0,0 @@
- Copyright (c) 2007-2010 Mike Karlesky, Mark VanderVoord, Greg Williams
-
- Permission is hereby granted, free of charge, to any person
- obtaining a copy of this software and associated documentation
- files (the "Software"), to deal in the Software without
- restriction, including without limitation the rights to use,
- copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the
- Software is furnished to do so, subject to the following
- conditions:
-
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
-
- The end-user documentation included with the redistribution, if
- any, must include the following acknowledgment: "This product
- includes software developed for the Unity Project, by Mike Karlesky,
- Mark VanderVoord, and Greg Williams and other contributors", in
- the same place and form as other third-party acknowledgments.
- Alternately, this acknowledgment may appear in the software
- itself, in the same form and location as other such third-party
- acknowledgments.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file