[jira] [Issue Comment Deleted] (BIGTOP-1031) README has outdated/ambiguous information

["jay vyas (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/BIGTOP-1031?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

jay vyas updated BIGTOP-1031:
-----------------------------

    Comment: was deleted

(was: diff --git a/README b/README
index 19e4102..b47a72c 100644
--- a/README
+++ b/README
@@ -32,7 +32,7 @@ and Ubuntu Quantal. They can probably be built for other platforms as
well.Some of the binary artifacts might be compatible with other closely
related distributions.
-Building Bigtop requires the following tools:
+Building all of Bigtop requires the following tools:
* Java JDK 1.6
* Apache Forrest 0.8 (requires 32bit version of Java JDK 1.5)
@@ -81,17 +81,38 @@ libopenssl-devel
WARNING: since testing packages requires installing them on a live
system it is highly recommended to use VMs for that.
-Testing Bigtop is done using iTest framework. For more documentation
-on iTest and testing visit Bigtop wiki http://bigtop.apache.org/,
+Testing Bigtop is done using iTest framework. The tests are organized in maven submodules, with
+one submodule per bigtop component.
+
+The bigtop-tests/test-execution/smokes/pom.xml defines all submodules to be tested, and
+each submodule is in its own directory under smokes/, for example:
+
+smokes/hadoop/pom.xml
+smokes/hive/pom.xml
+... and so on.
+
+For more documentation on iTest and testing visit Bigtop wiki http://bigtop.apache.org/,
but here's 2 steps to get started:
-* install package testing iTest artifacts locally:
+## Running the tests: Installing smoke tests
+* To install your iTest test jars locally (i.e. package/hadoop/flume/sqoop/...)
+
+ #Note: the --offline option should be used, after you have all dependencies, so that you don't
+ #overwrite your built snapshots with remote snapshots.
+ mvn install -DskipTests -DskipITs -DperformRelease -f bigtop-tests/test-execution/smokes/package/pom.xml
+
+## Running the tests: Running the installed smoke test jars on your cluster
+
+* Example 1: To run the iTest testing suite for the "packaging" submodule (i.e. package/hadoop/flume/sqoop/...)
+
+ mvn clean verify -Dbigtop.repo.file.url.CentOS=XXX -D'org.apache.maven-failsafe-plugin.testInclude=**/TestPackagesReadiness.*' -f bigtop-tests/test-execution/smokes/package/pom.xml
+
- cd test/src/smokes/package/ && mvn install -DskipTests -DskipITs -DperformRelease
+* Example 2: Running the mapreduce standard smokes - for the "hadoop" submodule, further specifying only those in the hadoop examples jar (like WordCount, Calculate PI, and so on):
-* use those locally installed iTest package testing artifacts to run a suite:
+ mvn clean verify -Dbigtop.repo.file.url.CentOS=XXX -D'org.apache.maven-failsafe-plugin.testInclude=**/*TestHadoopExamples*' -f bigtop-tests/test-execution/smokes/package/pom.xml
- cd test/suites/package/ && mvn clean verify -Dbigtop.repo.file.url.CentOS=XXX -D'org.apache.maven-failsafe-plugin.testInclude=**/TestPackagesReadiness.*'
+Note: A minor bug/issue is that you need the testInclude regular expression above is needed even if you want to run all tests, because iTest names don't follow the maven integration test naming convention of IT*, but instead, follow the surefire (unit test) convention of Test*.
## Contact us!)
    
> README has outdated/ambiguous information
> -----------------------------------------
>
>                 Key: BIGTOP-1031
>                 URL: https://issues.apache.org/jira/browse/BIGTOP-1031
>             Project: Bigtop
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.6.0
>         Environment: All
>            Reporter: jay vyas
>            Priority: Minor
>             Fix For: 0.7.0
>
>         Attachments: README.patch
>
>
> Readme has some incorrect/obsolete paths and the "packaging" example is somewhat confusing since, in fact, "packaging" is a maven term as well as a bigtop smoke.  Also, "cd" to the directory is unnecessary (just use mvn -f to specify pom).  Also, add more examples.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira