Closed Bug 1044144 Opened 10 years ago Closed 10 years ago

[titanic] Make runAnalysis API have optional 'delta' argument

Categories

(Testing :: General, defect)

x86
Linux
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: gakiwate, Assigned: bhalps, Mentored)

References

Details

(Whiteboard: [good first bug][lang=python])

Attachments

(1 file, 1 obsolete file)

Titanic (https://github.com/gakiwate/titanic/) is a tool to bisect test failures.

Titanic has APIs that allow other tools to interface with it. The API in concern for this bug, is the runAnalysis API which you can find at https://github.com/gakiwate/titanic/blob/master/titanic.py#L446

The API takes a mandatory argument of 'delta' which determines the range for which Titanic will bisect the failures.

We would like the 'delta' argument for this API to be optional and default to 7 in case the 'delta' argument isn't provided.
Whiteboard: good first bug][lang=python] → [good first bug][lang=python]
I'd like to take a shot at this as my first bug!
Great! The bug is yours! Let me know if you need any specific help.

If you have any questions you can ask them here on this bug or on #ateam on irc.mozilla.org

You can use test_titanic.py (https://github.com/gakiwate/titanic/blob/master/test_titanic.py) to test your implementation.

Good luck!
Status: NEW → ASSIGNED
Assignee: nobody → bahalperin
I'm not sure if I'm overlooking something or this was just a very simple fix.  Hope this helps and let me know how it looks!
Attachment #8462981 - Flags: review?(jmaher)
Hi Ben,

Great! The patch looks good. Can you change the reviewer to me so that I can approve and merge the patch?

Can you also update the documentation and test_titanic.py to reflect this addition. If you want, and if you have a Github account you can send the documentation and sample usage as a pull request to the Github repository. https://github.com/gakiwate/titanic

Also, you might want to look at BUG 1044169 which might be interesting for you. Alternatively, you can also look to AlertManager for cintributions. https://wiki.mozilla.org/Auto-tools/Projects/AlertManager

Let me know what you would like to take up further! :)
Attachment #8462981 - Flags: review?(jmaher) → review?(gautam.akiwate)
Hi Gautam,

I made you the reviewer and I updated the README and test_titanic.py.  I sent a pull request on GitHub.  It's telling me there's a merge conflict, but when I go to the command line and type "git status" everything seems to be OK.  Let me know if there are any issues and I'll fix them.

Also, could you please assign me to BUG 1044169?

Thanks!
Hi Ben,

You can assign the said bug to yourself.

There is a section called "Assigned To". There is a label next to it which says "take". Once you do that and save the changes you will have taken up and been assigned the bug. Let me know if it works out for you.

I'll get back on the pull requests.

Regards
Gautam
Comment on attachment 8462981 [details] [diff] [review]
'delta' argument for runAnalysis is now optional and defaults to 7 if no argument is provided.

Looks good to me.
Attachment #8462981 - Flags: review?(gautam.akiwate) → review+
For this patch, can you submit a new patch using 'git format-patch HEAD^' so that the patch has your information in it as well. That way, you get credit for your contribution?

The patch should include
1. The 'delta=7' change
2. Comment explaining what happens because of the change

If you need any git help you can ask on #ateam or #introduction and somebody will help you out. Don't be afraid to ask questions! :)
Comment on attachment 8462981 [details] [diff] [review]
'delta' argument for runAnalysis is now optional and defaults to 7 if no argument is provided.

Look at comment #8
When I use 'git format-patch HEAD^' the patch doesn't show the correct changes because I did so many commits on GitHub.  Would it be ok if I just run diff on the original files and my new ones, and save the output as an attachment here?  

Also I don't have an option to take the bug.  Next to "Assigned To:" it says "Nobody; OK to take it and work on it." but when I click my only options are Profile/Mail/Activity.
There is some magic flag in bugzilla when you switch from a new user to an experienced user that allows you to assign bugs.  

Regarding the diff, yes, please just do a diff and upload it here as a bugzilla attachment.  Likewise, you can refork and apply the final changes and submit a pull request.

Thanks for working on this!
Hi Ben,

So I assigned you the BUG :)

For this patch here is what would be the expected output. I'll also list the possible steps you might need to take to get there.

One commit that has the following.
  a. The 'delta' argument change
  b. Comment explaining the 'delta' argument change

To get there here is a tentative list of steps you might need to take.
1. Make a note of the changes you would like to make. After this, you can reset the branch to it's 
original state using 'git reset --hard' command. NOTE: This will eliminate all your changes. So be careful.

2. Once you have done this, make the changes for 'delta' argument and comment explaining the 'delta' argument changes. Add and commit the changes.

3. After this, you can run 'git format-patch HEAD^' to get a patch that has the above changes plus your information. And then you can upload your patch here.

For the changes to the README and test_titanic.py you would do something similar.
1. Commit that has changes to README and test_titanic.py

A useful command here would be 'git commit --amend' which will allow you to modify the previous commit with any modifications you realize you need to make.

Let me know how this goes :)

(In reply to Ben Halperin [:bhalps] from comment #10)
> When I use 'git format-patch HEAD^' the patch doesn't show the correct
> changes because I did so many commits on GitHub.  Would it be ok if I just
> run diff on the original files and my new ones, and save the output as an
> attachment here?  
> 
> Also I don't have an option to take the bug.  Next to "Assigned To:" it says
> "Nobody; OK to take it and work on it." but when I click my only options are
> Profile/Mail/Activity.
Attachment #8462981 - Attachment is obsolete: true
Attachment #8464315 - Flags: review?(gautam.akiwate)
I think everything went OK!!  Let me know if you find any other issues and thanks for your help!
Comment on attachment 8464315 [details] [diff] [review]
Bug 1044144 - Made-runAnalysis-argument-delta-optional.patch

Review of attachment 8464315 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good to me!

Merged: https://github.com/gakiwate/titanic/commit/1ef5c2a938f2c3350f066e9de5f2d80e953bea69
Attachment #8464315 - Flags: review?(gautam.akiwate) → review+
Congrats Ben! You have successfully completed and resolved this BUG!

Looking forward to seeing your work on the other BUG and many more bugs! :)
Status: ASSIGNED → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
Blocks: 1060551
No longer blocks: 1044200
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: