ranabirchakraborty/bug-clerk

A tool designed to control the "quality" of issue / task description (pretty much like tools like PMD or Checkstyle checks code quality).

BugClerk

Goals

What it is ? What would it help or solve ?

• A tool to ensure BZ / Jira data and metada are compliant to Red Hat processes and expectations, ex:

• If a BZ is switched to POST, it will check that a PR has been referenced

• or simply look at for a counterexample BZ1160715 ** It leverages our convention and process to implement a sort of quality control on the Bugzilla entry

• It's called BugClerk to help refering to it (rather the "tool"), and uses the image of a clerk checking your files and folder when submitting a request

What it is NOT ? What it won't aim to resolve ?

• It's not a workflow engine - BZ and/or JIRA has their own workflow engine, so it won't for instance change a BZ status
• it won't solve the tracking of fixes across several version (at least not the first implementation)

State of the art

I've googled a bit and ask around, and for now, I have not find any existing project or solution already aiming at that. Some people have obviously mentioned that bug tracker have some workflow mechanism, but also some feature, like the JIRA custom field and validation, that could implements the use cases I've mentioned.

Of course, if you do find some tools or library that , please feel free to update this section !_

Component / Frameworks

• jboss-set/aphrodite · GitHub‌
• Drools - Drools - Business Rules Management System (Java™, Open Source)
• Java A‌PI to acess Bugzilla

How to run it ?

You need to have credentials to access BugZilla.

The easiest way is to use bash scripts in src/main/bash:

export APHRODITE_CONFIG=path/to/aphrodite-config.json
export BUGCLERK_VERSION=<version-in-pom>
export BUGCLERK_HOME=<dir-containing-jar>

./run-on-bugid.sh https://issues.stage.jboss.org/browse/${issue-id}
./filter-based-run.sh

Getting some help:

java -Daphrodite.config="aphrodite-config.json" -jar ${BUGCLERK_HOME}/bugclerk-${VERSION}-shaded.jar --help

Try issue from Jira or Bugzilla:

$ java -cp ${BUGCLERK_HOME}/bugclerk-${VERSION}-shaded.jar org.jboss.jbossset.bugclerk.cli.BugClerkCLI https://issues.jboss.org/browse/JBEAP-8665
$ java -cp ${BUGCLERK_HOME}/bugclerk-${VERSION}-shaded.jar org.jboss.jbossset.bugclerk.cli.BugClerkCLI https://bugzilla.redhat.com/show_bug.cgi?id=1199194

Or you can simply retrieve all the BZs in a filter and have Bugclerk analyze them:

$ java -jar ${BUGCLERK_HOME}/bugclerk-${VERSION}-shaded.jar -H https://bugzilla.redhat.com/index.cgi -f 'https://bugzilla.redhat.com/buglist.cgi?cmdtype=runnamed&list_id=3525838&namedcmd=bz-created-on-EAP-in-the-last-hour&ctype=csv'

For commodity purpose, some launch scripts have been provided in src/main/bash.

How to build it ?

As usual, just run "mvn install". If you are using the 'bugzilla' command line tool, you can even run a some additional tests, checking the proper behavior of Bugclerk's command lines tool, by adding the following toogle:

$ mvn clean package test -Dbugclerk.run.cli.tests=true

Note that the tests are using the .bugzillarc file used by the 'bugzilla' command line tool just for commodity purpose. File syntax is pretty easy to implement if you are not using this tool:

$ cat ~/.bugzillarc
...
user = [email protected]
password = ********
...

How to release ?

Using the Maven Release Plugin, just follow its documentation on how to use the plugin.

However, prior to that, do the following "manual testing":

1. Build Bugclerk

    $ mvn clean install

2. Test it using the run.sh and filter-based-run.sh scripts to ensure the resulting JAR is working properly:

    $ export BUGCLERK_VERSION=<version-in-pom>  BUGCLERK_HOME=$(pwd)/target/
    $ ./src/main/bash/filter-based-run.sh
    ...
    # go to JIRA and pick a *open* issue URL - (not a CLOSED or RESOLVED one)
    $

Obviously, checks that the report is properly generated and double checks, especially for new checks, that there is no false+.

3. If new checks have been added, run the script update-rules-in-readme.sh and update the list at the bottom of this readme file.

    # edit README.md and remove *all* the checks links.
    $ ./src/main/bash/update-rules-in-readme >> README.txt

4. Use the maven plugin to execute the release itself - be careful our scheme for versioning differs from the plugin expectations.

Checks

Pretty much like a Checkstyle or PMD configuration, BugClerk values resides in the number of things it can checks. So, please to do hesitate to post "check request" on the issue tracker.

• AssignedButStillOnSET
• BZDepsShouldAlsoHaveFlags
• BZMatchStreamForBlockers
• BZMissingUpstream
• BZShouldHaveDevAckFlag
• BZShouldHaveQaAckFlag
• BZShouldHaveTimeEstimate
• ChangesInResolvedState
• CommunityBZ
• ComponentUpgradeMissingFixList
• ComponentUpgradeModifiedAfterSetToReadyForQA
• ComponentUpgradeReadyForQaDepsCheck
• [eval ( ! $dependsOn.isEmpty()); // dealt with by other above](https://github.com/jboss-set/bug-clerk/tree/master/core/src/main/resources/org/jboss/jbossset/bugclerk//eval ( ! $dependsOn.isEmpty()); // dealt with by other above.drl)
• FixVersionAndSprintMustMatchBetweenSiblings
• FixVersionChangesDuringSprint
• HighPriorityIssueNotAssigned
• IndexIssueByURL
• IndexPayloadTrackerByURL
• IssueComponentVersionVsPullRequestBranch
• IssueNotAssigned
• IssueOnPayloadButNotAssigned
• IssueStateModifiedAfterPrMerged
• IssueWorkedOnButNotQAAcked
• JIRAMatchStreamForIncorporated
• MilestonesSanityCheck
• MissingDownstreamDependencyLabel
• OneOffPatchNotForSet
• OnPayloadWithout3Acks
• PayloadComponentUpgradeShouldHaveAFix
• PayloadFixesMustHaveComponentUpgrade
• PostMissingPmAck
• PostMissingPR
• PRAgainstProperBranch
• PRLinksNoStreamsFound
• PRLinksNotValid
• RegressionMayImpactOneOffRelease
• ReleaseVersionMismatch
• RemoveViolationIfCheckIsIgnored
• ResolvedIssueWithFixVersionShouldHaveComponentUpgrade
• SprintVersionMismatch
• SummaryContainsPatchButTypeIsNotSupportPatch
• TargetRelease
• UpgradeJiraVersionDiscrepencies