Repository: incubator-samza Updated Branches: refs/heads/master 38f421f00 -> 4a3fd7ab3
SAMZA-392; adding test docs for travis ci Project: http://git-wip-us.apache.org/repos/asf/incubator-samza/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-samza/commit/4a3fd7ab Tree: http://git-wip-us.apache.org/repos/asf/incubator-samza/tree/4a3fd7ab Diff: http://git-wip-us.apache.org/repos/asf/incubator-samza/diff/4a3fd7ab Branch: refs/heads/master Commit: 4a3fd7ab34a91d27f89d44667b0393a00e0b2d5f Parents: 38f421f Author: Chris Riccomini <[email protected]> Authored: Thu Sep 11 14:52:14 2014 -0700 Committer: Chris Riccomini <[email protected]> Committed: Thu Sep 11 14:52:14 2014 -0700 ---------------------------------------------------------------------- docs/_layouts/default.html | 2 +- docs/contribute/tests.md | 69 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/4a3fd7ab/docs/_layouts/default.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 870ac99..6703caf 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -91,7 +91,7 @@ <li><a href="/contribute/design-documents.html">Design Documents</a></li> <li><a href="/contribute/code.html">Code</a></li> <li><a href="https://reviews.apache.org/groups/samza";>Review Board</a></li> - <li><a href="https://builds.apache.org/";>Unit Tests</a></li> + <li><a href="/contribute/tests.html">Tests</a></li> <li><a href="/contribute/disclaimer.html">Disclaimer</a></li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/4a3fd7ab/docs/contribute/tests.md ---------------------------------------------------------------------- diff --git a/docs/contribute/tests.md b/docs/contribute/tests.md new file mode 100644 index 0000000..84e1dbd --- /dev/null +++ b/docs/contribute/tests.md @@ -0,0 +1,69 @@ +--- +layout: page +title: Tests +--- +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +Samza's unit tests are written on top of [JUnit](http://junit.org/), and license checking is done with [Apache Rat](http://creadur.apache.org/rat/). An extensive integration test suite is not currently available. This is being actively worked on in [SAMZA-6](https://issues.apache.org/jira/browse/SAMZA-6) and [SAMZA-14](https://issues.apache.org/jira/browse/SAMZA-14). + +### Running Unit Tests Locally + +To run all tests, and license checks: + + ./gradlew clean check + +To run a single test: + + ./gradlew clean :samza-core:test -Dtest.single=TestSamzaContainer + +Test results are located in: + + <module name>/build/reports/tests/index.html + +#### Testing Scala and Java + +Samza's unit tests can also be run against all supported permutations of Scala and Java. + +To run the tests against a specific combination: + + ./gradlew -PscalaVersion=2.10 -PyarnVersion=2.4.0 clean check + +To run Samza's unit tests against all permutations, run: + + bin/check-all.sh + +When run on Linux, this command requires you to set three environment variables: + + JAVA6_HOME is not set. + JAVA7_HOME is not set. + JAVA8_HOME is not set. + +On Mac, check-all.sh will default to the appropriate path for each environment variable if it's not already set: + + JAVA6_HOME is not set. + JAVA6_HOME defaulted to /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home + JAVA7_HOME is not set. + JAVA7_HOME defaulted to /Library/Java/JavaVirtualMachines/jdk1.7.0_67.jdk/Contents/Home + JAVA8_HOME is not set. + JAVA8_HOME defaulted to /Library/Java/JavaVirtualMachines/jdk1.8.0_20.jdk/Contents/Home + +### Travis CI + +[Travis CI](https://travis-ci.org/apache/incubator-samza) has been configured to run Samza's unit tests after every commit to Samza's [master branch](https://git-wip-us.apache.org/repos/asf?p=incubator-samza.git;a=tree). The test results are mailed to the [developer mailing list](/community/mailing-lists.html), and posted in the [IRC channel](/community/irc.html). + +[](https://travis-ci.org/apache/incubator-samza)
