jmark99 commented on a change in pull request #1183: Update TESTING.md URL: https://github.com/apache/accumulo/pull/1183#discussion_r291387016
########## File path: TESTING.md ########## @@ -17,96 +17,88 @@ limitations under the License. # Testing Apache Accumulo -This document is meant to serve as a quick reference to the automated test suites included in Apache Accumulo for users -to run which validate the product and developers to continue to iterate upon to ensure that the product is stable and as -free of bugs as possible. +This document is meant to serve as a quick reference to the automated test suites of Accumulo. The automated testing suite can be categorized as two sets of tests: unit tests and integration tests. These are the traditional unit and integrations tests as defined by the Apache Maven [lifecycle][3] phases. # Unit tests Unit tests can be run by invoking `mvn test` at the root of the Apache Accumulo source tree. For more information see -the [maven-surefire-plugin docs][4]. +the [maven-surefire-plugin docs][4]. This command will run just the unit tests: -The unit tests should run rather quickly (order of minutes for the entire project) and, in nearly all cases, do not -require any noticable amount of computer resources (the compilation of the files typically exceeds running the tests). -Maven will automatically generate a report for each unit test run and will give a summary at the end of each Maven -module for the total run/failed/errored/skipped tests. +```bash +mvn clean test -Dspotbugs.skip -DskipITs +``` -The Apache Accumulo developers expect that these tests are always passing on every revision of the code. If this is not -the case, it is almost certainly in error. +# SpotBugs (formerly findbugs) -# Integration tests +[SpotBugs] will run by default when building Accumulo (unless "-Dspotbugs.skip" is used) and does a thorough static code +analysis of potential bugs. There is also a security findbugs plugin configured that can be run with this +command: -Integration tests can be run by invoking `mvn verify` at the root of the Apache Accumulo source tree. For more -information see the [maven-failsafe-plugin docs][5]. +```bash +mvn clean verify -Psec-bugs -DskipTests +``` -The integration tests are medium length tests (order minutes for each test class and order hours for the complete suite) -but are checking for regressions that were previously seen in the codebase. These tests do require a noticable amount of -resources, at least another gigabyte of memory over what Maven itself requires. As such, it's recommended to have at -least 3-4GB of free memory and 10GB of free disk space. +# Integration Tests -## Test Categories +The integration tests are medium length tests but are checking for regressions that were previously seen in the codebase. Review comment: Would it read better to replace 'but' with 'that'? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
