895841 - Enhance mutt so we can run mutt tests under Firefox Metro with --app=metrofirefox

Status: RESOLVED FIXED

(Testing Graveyard :: Mozmill, defect)

Description

[Andrei Eftimie]

Similar to mozmill, we need to be able to run mutt tests under Metro mode.
For implementation look at how it is done in mozmill

Example call:
> mutt testjs %binary_path% --app=metrofirefox

// this call should run all js mutt tests under Firefox Metro.

Comment 1

[Praveenkumar[:speaker]]

Hello I am a newbie can i work this bug

Comment 2

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Hey Praveenkumar, that would be great! I'll assign the bug to you. Fee free to ask questions on the bug or on IRC (#automation on irc.mozilla.org)

Andrei: Would you mind being a mentor for this while Henrik and I are on PTO?

Comment 3

[Andrei Eftimie]

Sure Dave.

Praveen, you can tag me on IRC for more information.

You will need a Windows 8 installation.
Download latest Nightly and set as default.
You'll know it worked when you can open it from the Windows 8 Metro (Touch) interface and Firefox will show you the custom Metro UI.

Get mozmill-env from http://mozqa.com/mozmill-env
You will use this to set up the python env under windows. Extract and use the executable as your command line tool.

Get mozmill from http://github.com/mozilla/mozmill
You will need Git to clone the repository.
CD into the mozmill folder, and run
> ./setup_development.py
This will install all dependencies for mozmill
If you now run
> mozmill --v
It should output the version 2.0rc4

Once you have the environment set up try to run a some tests under Metro.
> mozmill -m mutt/mutt/tests/js/testMetro/manifet.ini -b %path/to/firefox.exe% --app=metrofirefox

Once this works you need to enable the --app argument to mutt and make sure metrofirefox as a value will open the Metro UI.

You should be able to make the exact call as above but with mutt
> mutt -m mutt/mutt/tests/js/testMetro/manifet.ini -b %path/to/firefox.exe% --app=metrofirefox

Comment 4

[Karan Singh]

Hey,

I was wondering if it would be okay to take this bug if it hasn't been worked on in a while. 

Thanks,

Comment 5

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Karan, lets try if we can get a reply from Praveenkumar by tomorrow. If we don't get that feel free to work on this bug. Just let us know and someone from us can assign the bug to you then.

Comment 6

[Andrei Eftimie]

We haven't heard from Praveenkumar in more than 3 weeks, I thinks we can safely assume he doesn't have time at the moment.

I am assigning it to you Karan.
Look over comment 3 for more information.

You can find me on IRC in #automation

Comment 7

[Karan Singh]

Alright, sounds great.

Comment 8

[Andrei Eftimie]

Hi Karan, sorry you missed me on IRC.
I am usually online between 10:00 and 19:00 GMT+2.

Here is my response to your questions on IRC:

Mozmill seems to just call Mozrunner with the app argument (default Firefox):
https://github.com/mozilla/mozmill/blob/master/mozmill/mozmill/__init__.py#L106

The first step is to make Mutt accept the "-app" argument, I think they are registered here:
https://github.com/mozilla/mozmill/blob/master/mutt/mutt/mutt.py#L29

Then we'll need to make sure that Mutt will pass that desired --app argument value on to  Mozrunner (not sure, but I think this will need to be done through Mozmill)

Comment 9

[Karan Singh]

Well I'm able to make the call mutt 

-m mutt/mutt/tests/js/testMetro/manifet.ini -b %path/to/firefox.exe% --app=metrofirefox 

and have it open up metro firefox and run its test and pass.

I still have some implementation questions so I'll try to catch you the next time you're on IRC.

Cheers,

Comment 10

[Andrei Eftimie]

Sounds great Karan,

Feel free to upload a patch and ask for feedback if you have general questions.

Comment 11

[Andrei Eftimie]

Karan, any update on this?

From our irc conversation I remember you had a functioning patch, it just needed uploading in bugzilla.

Comment 12

[Karan Singh]

Hey,

Sorry, my schedule has been hectic for the past few weeks. Can you tell me the steps to create a patch with git?
I'll submit the patch as soon as I get to my PC.

Comment 13

[Andrei Eftimie]

Thanks Karan,

If you have a commit in git with your changes, make a patch with (this will make a patch from the last commit):
> git format-patch HEAD^

You can check the what the patch will contain with `git show`

Make sure to rebase onto master before so you'll have all code up-to-date

Comment 14

[Karan Singh]

Attachment: Patch for Bug 895841

Finally got around to creating a patch. Sorry for the wait!

Comment 15

[Andrei Eftimie]

Comment on attachment 809827 [details] [diff] [review]
Patch for Bug 895841

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

Hi Karan, 
2 small things to fix:

1) add the reviewer at the end of the commit message: "r=aeftimie"
2) there are some extra whitespaces as outlined below

Other than that, this appears to work great.
Thanks

(to make the git workflow easy, you can amend the last commit, so just do the changes and then issue `git commit --amend -m "Bug 895841 - added --app option to mutt. a=aeftimie"`)

::: mutt/mutt/mutt.py
@@ +190,4 @@
>      # Create logger for console
>      level = "DEBUG" if options.verbose else "INFO"
>      logger = LoggerListener(console_level=level)
> +    

nit: remove extra whitespace

@@ +196,1 @@
>      try:

nit: whitespace

Comment 16

[Karan Singh]

Attachment: 0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

Alright, I removed whitespace and updated the commit message.

Comment 17

[Andrei Eftimie]

Comment on attachment 813074 [details] [diff] [review]
0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

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

Thanks Karan,
this works fine!

Just one more thing, sorry I missed it before :(

::: mutt/mutt/mutt.py
@@ +45,5 @@
>       dict(dest="restart",
>            default=False,
>            action="store_true",
> +          help="Isolation mode (restart between each Mozmill test)")),
> +    (("--app", "--app"),

Could you please change the first item into "-a", that's how all other options are specified, and will allow us to also specify the option in short format "-a metrofirefox"

Comment 18

[Karan Singh]

Attachment: 0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

Good call, made the change.

Comment 19

[Karan Singh]

Attachment: 0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

Messed up the last patch.

Comment 20

[Andrei Eftimie]

Comment on attachment 814845 [details] [diff] [review]
0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

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

Looks good to me, lets defer to Henrik to take a look and land it if ok.

Comment 21

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Comment on attachment 814845 [details] [diff] [review]
0001-Bug-895841-added-app-option-to-mutt.-r-aeftimie.patch

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

That looks fantastic, Karan! There is only a very small nit, you might want to fix before I get this landed. With it you get my r+. Thanks!

::: mutt/mutt/mutt.py
@@ +48,5 @@
> +          help="Isolation mode (restart between each Mozmill test)")),
> +    (("-a", "--app"),
> +     dict(dest="app",
> +          default='firefox',
> +          help="Application to use [Default: %default]"))

nit: please use 'default' in lowercase here.

Comment 22

[Karan Singh]

Attachment: 0001-Bug-895841-added-app-option-to-mutt.-r-hskupin.patch

Great, here's the requested change.

-Karan

Comment 23

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Landed on master as:
https://github.com/mozilla/mozmill/commit/0e84e72d0d8081b39b00ed022b901b096b63850a

Thanks again Karan! If you have interest in more bugs please let us know or check our existing mentored bugs:
http://www.joshmatthews.net/bugsahoy/?automation=1

Comment 24

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Given that we need metro support for mutt already for mozmill 2.0.x I cherry-picked it for hotfix-2.0:
https://github.com/mozilla/mozmill/commit/1b04168a4dce9c1bfcca3c677d759a7cce4a0c05