Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Decide on how to run tests locally. Currently, functest is being used. We might need to investigate the feasibility and if required, set up new testing tool/architecture.
  2. The existing tests defined for functest/xtesting are old and cover only a subset of plugins that existed 2 years ago. 
    1. So tests will be needed for most plugins. There are a bunch of plugins that barometer uses:
      1. Log-parser -> Easy plugin to understand and get started
      2. Network Plugin -> For influx  db 
      3. SNMP Write Plugin
      4. Memory RAS
    2. Plugins from the Collectd PR's(Plus sign indicate a high frequency of PR's):
      1. ethstat plugin
      2. SNMP +
      3. Processes plugin +
      4. SQL plugin +
      5. Exec Plugin
      6. Threshold plugin +
      7. Memory plugin +
      8. Bind Plugin
      9. Network Plugin + 
  3. A review will be needed for the tests in baro_tests/ and determine whether these are suitable for the collectd community
  4. Set up triggering a Jenkins build when a PR is submitted to the collectd repository, run the job on node 5 of intel pod13 
  5. Contribute to making the barometer docs better, wherever there is confusion and things aren't mentioned clearly to make things easy for future contributors.


Tasks

Week

Activity

Week 1 - Week 3


  •  Explore Github Status API & Check how results could be posted back to Github with Jenkins
  •  Get familiar with opnfv Jenkins CI
  •  Selection of plugins for writing tests based on activity in collectd
  •  Update barometer set-up documentation in the repository to align with the docs 
  •  A review of the tests in baro_tests/ ,  fix, update and get them working
  •  Decide upon the testing framework and architecture for writing tests.

Week 4 - Week 6


  •  Test case development for log parser plugin
  •   Setting up CI pipeline with Jenkins (the slave Jenkins & webhooks on the collectd side)
  •   Documenting the test cases and expected output and overall Jenkins CI architecture.
  •  Get started with the review of Network Plugins
Week 7 - Week 9
  •  Test case creation for network plugin
  •  Review of SNMP write plugin followed by test case creation
  •  Review and creation of test cases for
  •  Document and update the test details in barometer docs
Week 10 - Week 12
  •  Review and test case development for SQL Plugin (high collectd PRs)
  •  

    Finishing up tasks, cleanup, possible demo, user guide etc. More focus on documenting existing work. Can possibly take up more plugins if we have cycles.


Implementation Details

We begin with a review of the tests in baro_tests/  ensure that they work well and determine whether these are suitable for the collectd community and for Barometer. The testing tool is not yet finalised and will be done based on further discussion with the Barometer community keeping all the use cases in mind.

...

However, the list of plugins is tentative and subject to change upon further discussions with Barometer and collectd community.

Milestones

Evaluation Date

Evaluation Criteria

Q1 June 19

  • Reviewed the tests in baro_tests/
  • Test framework and tools has been decided

Q2 July 10

  • Fixed existing test cases
  • Added test cases for (2) new plugins
  • Setup CI pipeline

Q3 July 31

  • Added tests for more plugins (3), mentioned in the timeline
  • Ensure all tests are automated
  • Ensure CI runs smoothly

Q4 August 21

  • Make sure all mentioned plugins(2+3+2) are covered
  • Make sure all kinds of tests exist (negative tests, unit tests, functional tests)
  • Ensure proper documentation