├── .gitignore ├── .travis.yml ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples └── parse_date.rs ├── src └── lib.rs └── tests └── all.rs /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | /target 3 | **/*.rs.bk 4 | Cargo.lock 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | - beta -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "uncover" 3 | version = "0.1.2" 4 | 5 | authors = ["Aleksey Kladov "] 6 | repository = "https://github.com/matklad/uncover" 7 | license = "MIT OR Apache-2.0" 8 | description = "A library to verify that a test covers specific code." 9 | categories = ["development-tools::testing"] 10 | 11 | [badges] 12 | maintenance = { status = "deprecated" } 13 | 14 | [dependencies] 15 | lazy_static = "1" 16 | 17 | [dev-dependencies] 18 | crossbeam = "0.2" 19 | 20 | [[example]] 21 | name = "parse_date" 22 | crate_type = ["lib"] 23 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # uncover 2 | 3 | [![Build Status](https://travis-ci.org/matklad/uncover.svg?branch=master)](https://travis-ci.org/matklad/uncover) 4 | [![Crates.io](https://img.shields.io/crates/v/uncover.svg)](https://crates.io/crates/uncover) 5 | [![API reference](https://docs.rs/uncover/badge.svg)](https://docs.rs/uncover/) 6 | 7 | **DEPRECATED:** use https://github.com/matklad/cov-mark instead. 8 | 9 | A library that makes tests easier to maintain by using instrumentation to 10 | answer these two questions: 11 | * Which code is exercised by this test? 12 | * Which test covers this bit of code? 13 | 14 | See the [docs](https://docs.rs/uncover/) for more. 15 | -------------------------------------------------------------------------------- /examples/parse_date.rs: -------------------------------------------------------------------------------- 1 | #[macro_use] 2 | extern crate uncover; 3 | 4 | // This defines two macros, `covers!` and `covered_by!`. 5 | // They will be no-ops unless `cfg!(debug_assertions)` is true. 6 | define_uncover_macros!( 7 | enable_if(cfg!(debug_assertions)) 8 | ); 9 | 10 | pub fn parse_date(s: &str) -> Option<(u32, u32, u32)> { 11 | if 10 != s.len() { 12 | covered_by!("short date"); 13 | return None; 14 | } 15 | 16 | if "-" != &s[4..5] || "-" != &s[7..8] { 17 | covered_by!("wrong dashes"); 18 | return None; 19 | } 20 | 21 | let year = &s[0..4]; 22 | let month = &s[6..7]; 23 | let day = &s[8..10]; 24 | 25 | year.parse::().ok().and_then( 26 | |y| month.parse::().ok().and_then( 27 | |m| day.parse::().ok().map( 28 | |d| (y, m, d)))) 29 | } 30 | 31 | 32 | #[test] 33 | fn test_parse_date() { 34 | { 35 | covers!("short date"); 36 | assert!(parse_date("92").is_none()); 37 | } 38 | 39 | // This will fail. Although the test looks like 40 | // it exercises the second condition, it does not. 41 | // The call to `covers!` call catches this bug in the test. 42 | // { 43 | // covers!("wrong dashes"); 44 | // assert!(parse_date("8-26-1914").is_none()); 45 | // } 46 | 47 | { 48 | covers!("wrong dashes"); 49 | assert!(parse_date("19140-8-26").is_none()); 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! # uncover 2 | //! 3 | //! **DEPRECATED:** use https://github.com/matklad/cov-mark instead. 4 | //! 5 | //! A library that makes tests easier to maintain by using instrumentation to 6 | //! answer these two questions: 7 | //! * Which code is exercised by this test? 8 | //! * Which test covers this bit of code? 9 | //! 10 | //! Here's a short example: 11 | //! 12 | //! ``` 13 | //! #[macro_use] 14 | //! extern crate uncover; 15 | //! 16 | //! // This defines two macros, `covers!` and `covered_by!`. 17 | //! // They will be no-ops unless `cfg!(debug_assertions)` is true. 18 | //! define_uncover_macros!( 19 | //! enable_if(cfg!(debug_assertions)) 20 | //! ); 21 | //! 22 | //! fn parse_date(s: &str) -> Option<(u32, u32, u32)> { 23 | //! if 10 != s.len() { 24 | //! // By using `covered_by!("unique_name")` 25 | //! // we signal which test exercises this code. 26 | //! covered_by!("short date"); 27 | //! return None; 28 | //! } 29 | //! 30 | //! if "-" != &s[4..5] || "-" != &s[7..8] { 31 | //! covered_by!("wrong dashes"); 32 | //! return None; 33 | //! } 34 | //! // ... 35 | //!# unimplemented!() 36 | //! } 37 | //! 38 | //! #[test] 39 | //! fn test_parse_date() { 40 | //! { 41 | //! // `covers!("unique_name")` creates a guard object 42 | //! // that verifies that by the end of the scope we've 43 | //! // executed the corresponding `covered_by!("unique_name")`. 44 | //! covers!("short date"); 45 | //! assert!(parse_date("92").is_none()); 46 | //! } 47 | //! 48 | //! // This will fail. Although the test looks like 49 | //! // it exercises the second condition, it does not. 50 | //! // The call to `covers!` call catches this bug in the test. 51 | //! // { 52 | //! // covers!("wrong dashes"); 53 | //! // assert!(parse_date("27.2.2013").is_none()); 54 | //! // } 55 | //! 56 | //! { 57 | //! covers!("wrong dashes"); 58 | //! assert!(parse_date("27.02.2013").is_none()); 59 | //! } 60 | //! } 61 | //! 62 | //! # fn main() {} 63 | //! ``` 64 | //! 65 | //! ## Notes on concurrency 66 | //! 67 | //! Coverage is tracked via shared mutable state, so the following 68 | //! caveat applies: 69 | //! 70 | //! * A `covers!` from one test might be covered by thread of *another* test. 71 | //! As a result, a test might pass when it should have failed. 72 | //! 73 | //! The error in the opposite direction never happens: if your code covers everything 74 | //! with a single thread, it will do it with several threads as well. 75 | 76 | #[macro_use] 77 | extern crate lazy_static; 78 | 79 | use std::{ 80 | sync::Mutex, 81 | collections::HashMap, 82 | }; 83 | 84 | 85 | /// Define `covered_by!` and `covers!` macros. 86 | /// 87 | /// Use `covered_by!("unique_name")` in the code and 88 | /// `covers!("unique_name")` in the corresponding test to verify 89 | /// that the test indeed covers the code. Under the hood, 90 | /// `covers!` creates a guard object that checks coverage at scope 91 | /// exit. 92 | /// 93 | /// If called as `define_uncover_macros(enable_if(condition));`, 94 | /// macros will be no-op unless condition is true. A typical condition 95 | /// is 96 | /// 97 | /// ``` 98 | /// # #[macro_use] extern crate uncover; 99 | /// define_uncover_macros!( 100 | /// enable_if(cfg!(debug_assertions)) 101 | /// ); 102 | /// ``` 103 | /// 104 | /// You can use condition to enable uncover based on compile-time env var: 105 | /// 106 | /// ``` 107 | /// # #[macro_use] extern crate uncover; 108 | /// define_uncover_macros!( 109 | /// enable_if(option_env!("CI") == Some("1")) 110 | /// ); 111 | /// ``` 112 | #[macro_export] 113 | macro_rules! define_uncover_macros { 114 | (enable_if($cond:expr)) => { 115 | #[doc(hidden)] 116 | pub use $crate::__CoversGuard; 117 | #[doc(hidden)] 118 | pub use $crate::__covers_record_coverage; 119 | 120 | #[macro_export] 121 | macro_rules! covers { 122 | ($pos:expr) => { 123 | let mut _guard = None; 124 | if $cond { 125 | _guard = Some($crate::__CoversGuard::new($pos)) 126 | } 127 | }; 128 | } 129 | 130 | #[macro_export] 131 | macro_rules! covered_by { 132 | ($pos:expr) => { 133 | if $cond { 134 | $crate::__covers_record_coverage($pos); 135 | } 136 | }; 137 | } 138 | }; 139 | } 140 | 141 | 142 | lazy_static! { 143 | static ref STATE: Mutex> = Default::default(); 144 | } 145 | 146 | #[doc(hidden)] 147 | pub fn __covers_record_coverage(pos: &'static str) { 148 | *STATE.lock().unwrap().entry(pos).or_insert(0) += 1; 149 | } 150 | 151 | #[doc(hidden)] 152 | pub fn __covers_get_coverage(pos: &'static str) -> u64 { 153 | *STATE.lock().unwrap().get(pos).unwrap_or(&0) 154 | } 155 | 156 | 157 | #[doc(hidden)] 158 | pub struct __CoversGuard { 159 | pos: &'static str, 160 | cnt: u64, 161 | } 162 | 163 | impl __CoversGuard { 164 | #[doc(hidden)] 165 | pub fn new(pos: &'static str) -> __CoversGuard { 166 | let cnt = __covers_get_coverage(pos); 167 | __CoversGuard { pos, cnt } 168 | } 169 | } 170 | 171 | impl Drop for __CoversGuard { 172 | fn drop(&mut self) { 173 | if ::std::thread::panicking() { 174 | return; 175 | } 176 | if !(self.cnt < __covers_get_coverage(self.pos)) { 177 | panic!("not covered: {:?}", self.pos); 178 | } 179 | } 180 | } 181 | -------------------------------------------------------------------------------- /tests/all.rs: -------------------------------------------------------------------------------- 1 | extern crate crossbeam; 2 | 3 | #[macro_use] 4 | extern crate uncover; 5 | 6 | define_uncover_macros!( 7 | enable_if(true) 8 | ); 9 | 10 | fn foo() { 11 | covered_by!("foo"); 12 | } 13 | 14 | fn bar() { covered_by!("bar"); } 15 | 16 | fn baz() {} 17 | 18 | #[test] 19 | fn test_covered() { 20 | covers!("bar"); 21 | bar(); 22 | } 23 | 24 | #[test] 25 | #[should_panic] 26 | fn test_not_covered() { 27 | covers!("bar"); 28 | baz(); 29 | } 30 | 31 | #[test] 32 | fn no_multithreaded_false_positives() { 33 | crossbeam::scope(|scope| { 34 | for _ in 0..100 { 35 | scope.spawn(|| { 36 | for _ in 0..100 { 37 | covers!("foo"); 38 | foo(); 39 | } 40 | }); 41 | } 42 | }) 43 | } 44 | --------------------------------------------------------------------------------