@icyphy/github-issue-junit

Read JUnit HTML output and add a comment to an open issue on GitHub.

Stats

StarsIssuesVersionUpdatedCreatedSize
@icyphy/github-issue-junit
100.1.73 years ago3 years agoMinified + gzip package size for @icyphy/github-issue-junit in KB

Readme

Based on https://github.com/vitalets/github-trending-repos/ and a suggestion by @nebgnahz.

Read JUnit HTML output and add a comment to an open issue on GitHub.

This module hacks around the problem of running a Travis-CI job and wanting to notify users of failed tests.

This is a start on solving Handle Ant's JUnit XML formatted output from test/spec runs.

See https://github.com/icyphy/ptII-test/issues/1 for sample output.

To Do

  1. The contents of the JUnit html output file overview-summary.html is being parsed, which seems fragile.
  2. It might be good to list the tests that have failed.
  3. It might be good to notice if new tests have failed.

How to use

  1. Set up your Travis-ci job to run JUnit tests, save the output as xml and upload the test results to GitHub pages. See ptII/.travis.yml and ptII/bin/ptIITravisBuild.sh.

  2. In the gh-pages branch, run the ant junitreport target in frames format. See build.xml. The main thing is to create the JUnit HTML summary page at an accessible location.

  3. Create an issue in your GitHub repo that will be the issue that gets updated with the test results. See https://github.com/icyphy/ptII-test/issues/1

  4. Create a label for the issue that signifies that it will be updated, for example junit-results.

  5. Add the URL of the JUnit summary results page created by running the ant junitresults target, for example https://icyphy.github.io/ptII-test/reports/junit/html/overview-summary.html. This tool looks for issues with a specific label and searches for urls that matches a regular expression defined in scripts/config.js. So the issues need to ahve the appropriate label and the appropriate URL.

  6. In your environment, set the JUNIT_LABEL variable to the name of the label created above

    export JUNIT_LABEL=junit-results
    
  7. In your environment, set GITHUB_ISSUE_JUNIT to the API URL of the repo containing the JUnit output:

    export GITHUB_ISSUE_JUNIT=https://api.github.com/repos/icyphy/ptII-test
    
  8. Edit the regular expressions in scripts/helpers/issues.js. (FIXME: These should be environment varialbles)

  1. To update an issue from Travis-ci, get a GitHub token

  2. On GitHub, under your account on the upper right, click on Settings -> Developer Settings -> Personal access tokens -> Generate new token

  3. The new token should have public_repo status

  4. On Travis-ci, on your project page, click on More options -> Settings, then add the token from the step above as GITHUB_TOKEN

  5. For testing purposes, set the GITHUB_TOKEN environment variable on your local machine

  6. If necessary, update any other variables in scripts/config.js

  7. To test:

    node ./scripts/junit-results.jso
    
  8. To actually upload the results to an issue:

    export JUNIT_RESULTS_NOT_DRY_RUN=false
    node ./scripts/junit-results.js
    
  9. To have Travis do the update, create a script: ``` #!/bin/bash

mkdir node_modules npm install @icyphy/github-issue-junit export JUNIT_LABEL=junit-results export JUNIT_RESULTS_NOT_DRY_RUN=false export GITHUB_ISSUE_JUNIT=https://api.github.com/repos/cxbrooks/travis-junit (cd node_modules/@icyphy/github-issue-junit/scripts; node junit-results.js)



# How to clean results that are older than 30 days

1. Follow steps 1 - 7 above

2. To test

node ./scripts/issue-cleaner.js


3. To actually upload the results to an issue:

export JUNIT_RESULTS_NOT_DRY_RUN=false node ./scripts/issue-cleaner.js



# How to publish updates to this module

1.  Update the patch number in package.json
2.  Login to npm
        npm login

        Username: icyphy-npm
        Password: See https://wiki.eecs.berkeley.edu/ptolemy/Ptolemy/Accounts or passwords/icyphy-npm in the  https://repo.eecs.berkeley.edu/git/projects/ealprivi/ealprivi.git repo.
        Email: icyphy-npm@icyphy.org
3.  Publish:
        npm publish --access public

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.