mallozup/kubeojo

Health Analytics for testsuites with elixir and d3js (inspired by CHAOSS)

"What is kubeojo?" in 10 seconds

Developing kubeojo

See devel-setup

How to run kubeojo

At this point kubeojo is under active development and has not yet reached version 1.0. As soon as a stable version is ready, the docs will be updated to describe how to run kubeojo. ( Please feel free to pick up issues from GitHub if you want to contribute for version 1.0)

What is kubeojo?

Nowadays, it is extremely common that projects have a test suite running on CI system to ensure the project's stability.

When test suites get big, it is very often the case that there are "brittle tests" in the suite. These are the kinds of tests that typically run just fine, but randomly fail from time to time (such as once every 10 runs or so).

Kubeojo methodically examines your tests failures. It stores the results and visualizes the "brittle tests" to help detect and fix them. The UI of kubeojo is powered by Phoenix 1.3 and D3.js.

Configuration:

In order to use kubeojo, you need to have 2 YAML files configured:

1. Jenkins credentials: kubeojo/kubeojo/config/jenkins_credentials.yml

as password you can use the a Jenkins Token:

jenkins_url: "https://i_love_opensuse.ci.com/"
username: "Jenkins_username"
password: "2faidfakjfdkjadf30ff"

2. Jenkins Jobs you want to analyze:

kubeojo/kubeojo/config/jenkins_jobs.yml

Here you should insert the name of the jobs you want to analyze the tests results for.

Important: your jobs need to export tests in junit-format to ensure kubeojo can fetch the junit_results.

jenkins_jobs: ["manager-3.1-cucumber", "manager-Head-cucumber"]

Roadmap:

https://github.com/MalloZup/kubeojo/issues

Contributors:

Thanks to all contributors for kubeojo!

kubeojo's Issues

Add typespec ans dyalizher

Add typespec and dyalizher

explore d3.js graphs for finding other usefull graph

we will use this https://bl.ocks.org/mbostock/7607535, but we might research if there would be other usefull graphs that we could add.

improve readme and user experience

improve readme and reduce comlexity of documentation ! also fix typo and complexity in doc

explore d3.js and choose a web-framework (rails or phoenix)

Goals:

Choose a webframework (rails or phoenix) .

Ruby is at moment the most usefull with gems and utils already there for use.

tests the phoenix app

Implement tests automated in travis-ci for webapp and databases side.

improve layout of buble chart

for small bubble the layout is not optimal.

try to improve it once everything is fine 😄

deploy final app in container

deploy phoenix server via docker container

implement other backend from other data

implement in elixir another backend that could fetch data not only from Jenkins but others type of endpoints or files

designer: create logo

create logo for kubeojo

It should be something with an eye for having control and something that would also give ideas for analyze/forensic of tests.
It should be also something relaxed and funny, not a big brother eye 🤣

TEST

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Implement junit failure backend

junit failure data retrival

todo:

• parse json with poison for retrive all build number from jobname

• given the maps of testsfailures implement a count system, that will store this in db

example

jobname Apple
 %{"ping_test" => 50, "build_test" => "230"}
Jobname Banana
..
Jobname Legume

D3js visualisation

Once we have data in DB we need to visualize it on D3.js with javascript etc.

We need to adapt the graphs accordingly.

• learning D3.js
• read current failure and visualize them.
• adapt graphics and style
• find out if className is needed

counting testname occurrency is not working

https://github.com/MalloZup/kubeojo/blob/master/kubeojo/lib/jenkins/jenkins_analyze.ex#L23

find out an official way to deploy kubeojo

at moment one can use kubeojo in devel mode. ( there is doc for that)

However there is not already a user/official mode to deploy kubeojo

We should just investigate and make the deploy part easier

Use credo as linter

setup phoenix with d3.js library

Setup phoenix with d3.js lib

integrate in kubeojo "yes we ship it"

https://github.com/cornelius/yes_ship_it

Write Jenkins results to database

Tasks

We need to write data to DB, this need to have also the count of the failures.

Howto write data (simplified workflow)

1. Check if Jobname exist otherwise create it
2. Check If Jobname has jobnumber and buildtimestamp ( if they are alredy there data is alredy in and we parsed already)
   3 Check if tesname "test_present_empty_dir". If exist increment +1 otherwise create name with = 0

Data example

  %{
    failures: [
      %{
        build_timestamp: 1531421004326,
        jobnumber: 8,
        testsname: ["test_present_empty_dir", "test_numeric_rev",
         "test_issue_2726_mode_kwarg", "test_test_directory",
         "test_latest_changed_local_branch_rev_develop",
         "test_archive_extracted_with_non_base_saltenv", "test_replace",
         "test_replace_issue_18612_prepend", "test_comment",
         "test_replace_issue_18612_change_mid_line_with_comment",
         "test_append_issue_1864_makedirs", "test_latest_failure",
         "test_test_managed", "test_serialize", "test_local_archive_extracted",
         "test_file_managed_http_source_no_hash", "test_present_fail",
         "test_issue_25250_force_copy_deletes", "test_latest",
         "test_managed_file_mode_keep",
         "test_managed_local_source_does_not_exist",
         "test_local_archive_extracted_skip_verify", "test_absent",
         "test_run_creates_exists", "test_issue_12209_no_follow_symlinks",
         "test_directory_clean_require_in_with_id", "test_recurse",
         "test_test_directory_clean_exclude",
         "test_archive_extracted_with_strip_in_options", "test_directory",
         "test_managed_file_mode_file_exists_replace",
         "test_file_managed_http_source_skip_verify", "test_absent_dir",
         "test_recurse_template",
         "test_archive_extracted_without_archive_format",
         "test_local_archive_extracted_with_source_hash", "test_run_watch",
         "test_managed_file_with_pillardefault_sls", "test_patch_hash_mismatch",
         "test_recurse_specific_env", "test_directory_clean_require_with_name",
         "test_function_do_not_return_dictionary_type", ...]
      },
      %{build_timestamp: 1531416213843, jobnumber: 7, testsname: []},
      %{build_timestamp: 1531309747420, jobnumber: 6, testsname: []},
      %{
        build_timestamp: 1531296005199,
        jobnumber: 5,
        testsname: ["test_present_empty_dir", "test_numeric_rev",
         "test_issue_2726_mode_kwarg", "test_test_directory",
         "test_latest_changed_local_branch_rev_develop",
         "test_archive_extracted_with_non_base_saltenv", "test_replace",
         "test_replace_issue_18612_prepend", "test_comment",
         "test_replace_issue_18612_change_mid_line_with_comment",
         "test_append_issue_1864_makedirs", "test_latest_failure",
         "test_test_managed", "test_serialize", "test_local_archive_extracted",
         "test_file_managed_http_source_no_hash", "test_present_fail",
         "test_issue_25250_force_copy_deletes", "test_latest",
         "test_managed_file_mode_keep",
         "test_managed_local_source_does_not_exist",
         "test_local_archive_extracted_skip_verify", "test_absent",
         "test_run_creates_exists", "test_issue_12209_no_follow_symlinks",
         "test_directory_clean_require_in_with_id", "test_recurse",
         "test_test_directory_clean_exclude",
         "test_archive_extracted_with_strip_in_options", "test_directory",
         "test_managed_file_mode_file_exists_replace",
         "test_file_managed_http_source_skip_verify", "test_absent_dir",
         "test_recurse_template",
         "test_archive_extracted_without_archive_format",
         "test_local_archive_extracted_with_source_hash", "test_run_watch",
         "test_managed_file_with_pillardefault_sls", "test_patch_hash_mismatch",
         ...]
      }
    ],
    jobname: 'manager-products-pipeline-saltstack-integration-sles12sp3'
  }

choose a db for kubeojo

• postgres
• nosql
• others