(Help wanted!) More and more tests!

mauricioaniche commented 4 years ago

CK is a simple tool; yet, people's code are complicated!! Although our test suite has been growing, there are always exceptional cases that might lead the tool to bring strange results.

If you are looking for a way to start contributing to this project, I suggest you to write tests!! Our test suite is full of examples! In practice, all you need to do is:

Create a "fake" class with the property you want to assert, e.g., does CK calculate WMC well when we have a ternary if in the code? This code goes to the /fixture folder
Feel free to either add your test to an existing one (e.g., if you are adding one more test for the WMC metric, this method should be in the WMCTest class) or add a new file (e.g., you are testing a more holistic behaviour, and this behaviour does not depend on a single metric)
Write a test that executes CK in the folder that contains your fixture.
Write good assertions! Try to assert as much as possible. Good assertions are key! A good one to remember is to assert the value of that metric at class and method level (we have found bugs where the metric at method-level was correct, but at class-level, there was a bug)!

Submit your tests as a PR!

If you found a bug, THANK YOU! Feel free to fix it yourself! If you can't, no worries. Just open an issue, and I'll work on that!

mauricioaniche commented 4 years ago

The RFC metric is one that deserves a lot more tests!

maykon-oliveira commented 4 years ago

I have a question, should be method reference counted in RFC metric?

Map<Character, List<Integer>> byAlphabet =
        aList.stream()
            .collect(
                Collectors.groupingBy(
                    e -> new Character(e.getName().charAt(0)),
                    Collectors.mapping(Avatar::getId, Collectors.toList())));

For example, that's stream above, there is a method reference, but currently RFC does not include it.

So, the result of RFC metric above is 7, what should be the result 7 or 8?

RFC test file at line 82

mauricioaniche commented 4 years ago

We are probably not counting the Avatar::getId, but maybe we should! Would you mind fixing it and opening a PR?

maykon-oliveira commented 4 years ago

Sure!

I opened up a pull request

mauricioaniche / ck

(Help wanted!) More and more tests! #36

Sure!