Uploaded image for project: 'Giraph'
  1. Giraph
  2. GIRAPH-22

Sort out examples from unit test helpers in examples package

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Patch Available
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Within src/examples there are quite a few files defined that are mainly used in unit or other tests:

      • GeneratedVertexInputFormat
      • GeneratedVertexInputFormat
      • LongSumAggregator
      • MaxAggregator
      • MinAggregator
      • SimpleCombinerVertex
      • SimpleFailVertex
      • SimpleMsgVertex
      • SimpleMutateGraphVertex
      • SimpleSumCombiner
      • SumAggregator
      • SuperstepBalancer

      Several of these explicitly say they're designed to aid in unit testing. If these are indeed meant for testing, they should be moved to the test directory. If they're examples, it would be better to sort out the overly complicated ones and ones that include lots of tests and asserts, so only to show the essence of the example. Hopefully the examples directory have a few, very heavily documented programs of the helloworld/word count/shortest path variety (with sample inputs) that can be quickly launched. Once new developers grok these, they can turn to the unit tests, which can of course be great sources to learn the code from.

        Attachments

        1. GIRAPH-22.patch
          8 kB
          Maja Kabiljo
        There are no Sub-Tasks for this issue.

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              jghoman Jakob Homan
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: