Bigtop
  1. Bigtop
  2. BIGTOP-1031

README has outdated/ambiguous information

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.6.0
    • Fix Version/s: 0.7.0
    • Component/s: documentation
    • Environment:

      All

      Description

      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.

      1. README.patch
        3 kB
        jay vyas
      2. BIGTOP-1031.1.patch
        3 kB
        jay vyas
      3. BIGTOP-1031.2.patch
        6 kB
        jay vyas

        Activity

        jay vyas created issue -
        jay vyas made changes -
        Field Original Value New Value
        Status Open [ 1 ] Patch Available [ 10002 ]
        jay vyas made changes -
        Status Patch Available [ 10002 ] Open [ 1 ]
        Hide
        jay vyas added a comment -

        This is a patch for the README in bigtop which has an extra example, as well as corrected paths and simpler mvn invocations.

        Show
        jay vyas added a comment - This is a patch for the README in bigtop which has an extra example, as well as corrected paths and simpler mvn invocations.
        jay vyas made changes -
        Attachment README.patch [ 12593243 ]
        jay vyas made changes -
        Comment [ 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! ]
        Hide
        Mark Grover added a comment -

        Hi Jay, thanks for contributing! It looks good to me. May I request you to provide a patch via git format-patch, please?

        This the workflow I personally follow:
        1. Ensure that you have all of your change as 1 commit which has the correct commit message - something like BIGTOP-1031: README has outdated/ambiguous information
        2. Then run a command like: git format-patch HEAD^..HEAD --stdout > BIGTOP-1031.1.patch
        3. Upload the BIGTOP-1031.1.patch file to this JIRA

        git format-patch works better for all of us because it's easy to attribute the commit to you in the git history since it contains your name and email address.

        Show
        Mark Grover added a comment - Hi Jay, thanks for contributing! It looks good to me. May I request you to provide a patch via git format-patch , please? This the workflow I personally follow: 1. Ensure that you have all of your change as 1 commit which has the correct commit message - something like BIGTOP-1031 : README has outdated/ambiguous information 2. Then run a command like: git format-patch HEAD^..HEAD --stdout > BIGTOP-1031 .1.patch 3. Upload the BIGTOP-1031 .1.patch file to this JIRA git format-patch works better for all of us because it's easy to attribute the commit to you in the git history since it contains your name and email address.
        Hide
        jay vyas added a comment -

        Updated patch using "git format-patch BIGTOP-1031.1.patch" with correct commit mesage.

        Show
        jay vyas added a comment - Updated patch using "git format-patch BIGTOP-1031 .1.patch" with correct commit mesage.
        jay vyas made changes -
        Attachment BIGTOP-1031.1.patch [ 12593787 ]
        Hide
        jay vyas added a comment -

        Thanks mister grover! I've attempted to do the patch correctly above
        Is this ok?

        Show
        jay vyas added a comment - Thanks mister grover! I've attempted to do the patch correctly above Is this ok?
        Hide
        Mark Grover added a comment -

        Thanks Jay! It's looking good except that I wasn't able to apply it on the bigtop trunk. Any chance you haven't pulled in a while? If so, can you please pull bigtop trunk and rebase your patch on top of that?

        Thanks again and sorry about the hassle!

        Show
        Mark Grover added a comment - Thanks Jay! It's looking good except that I wasn't able to apply it on the bigtop trunk. Any chance you haven't pulled in a while? If so, can you please pull bigtop trunk and rebase your patch on top of that? Thanks again and sorry about the hassle!
        Hide
        jay vyas added a comment -

        Here is a new patch for master which updates the README to the same state as the old patch did for 0.6.0

        Show
        jay vyas added a comment - Here is a new patch for master which updates the README to the same state as the old patch did for 0.6.0
        jay vyas made changes -
        Attachment BIGTOP-1031.2.patch [ 12594467 ]
        Konstantin Boudnik made changes -
        Labels hackathon-7-2013
        Hide
        Mark Grover added a comment -

        +1

        Show
        Mark Grover added a comment - +1
        Hide
        Mark Grover added a comment -

        And, committed!
        https://git-wip-us.apache.org/repos/asf?p=bigtop.git;a=commit;h=b2c03ce0353abff02af0a84553ae30f4e04aca88

        Congratulations on your first Bigtop commit, Jay. Looking forward to many more!

        Show
        Mark Grover added a comment - And, committed! https://git-wip-us.apache.org/repos/asf?p=bigtop.git;a=commit;h=b2c03ce0353abff02af0a84553ae30f4e04aca88 Congratulations on your first Bigtop commit, Jay. Looking forward to many more!
        Konstantin Boudnik made changes -
        Assignee jay vyas [ jayunit100 ]
        Mark Grover made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Roman Shaposhnik made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open Patch Available Patch Available
        2m 30s 1 jay vyas 19/Jul/13 20:25
        Patch Available Patch Available Open Open
        21s 1 jay vyas 19/Jul/13 20:25
        Open Open Resolved Resolved
        8d 2h 14m 1 Mark Grover 27/Jul/13 22:40
        Resolved Resolved Closed Closed
        99d 23h 44m 1 Roman Shaposhnik 04/Nov/13 21:24

          People

          • Assignee:
            jay vyas
            Reporter:
            jay vyas
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development