968530 - Basic robocop test for Home.panels API

Status: RESOLVED INCOMPLETE

(Firefox for Android Graveyard :: Testing, defect)

Description

[:Margaret Leibovic]

Now that bug 964375 landed, we should be able to write a simple robocop test to add a panel and make sure it shows up on about:home, then remove it and make sure it's gone.

See testHomeBanner for inspiration:
https://hg.mozilla.org/mozilla-central/rev/b79bb3ab6ca2

Comment 1

[Ashish Namdev]

Hi Margaret ,

i would like to work on this for getting started with automation.

i a new in Firefox for android automation
please let me know how to proceed with this bug.


Thank you 

BR,
Ashish N

Comment 2

[:Margaret Leibovic]

Awesome! First of all, do you have a Firefox for Android development environment set up? If not, you'll need to follow the steps here: https://wiki.mozilla.org/Mobile/Fennec/Android

Once you get that set up, you should make sure you can run robocop tests locally. There are some instructions on that here: https://wiki.mozilla.org/Auto-tools/Projects/Robocop

As I mentioned in the bug description, we could model these tests off the testHomeBanner tests.

There's documentation on the Home.panels API here:
https://developer.mozilla.org/en-US/Add-ons/Firefox_for_Android/API/Home.jsm/panels

And you can see some sample code in these add-ons:
https://github.com/leibovic/hub-boilerplate
https://github.com/leibovic/hub-kitchen-sink

It would also be awesome if you wanted to contribute to my kitchen sink add-on, it's definitely not complete :)

Comment 3

[:Margaret Leibovic]

Hey Ashish, how's it going? I'm going to unassign this bug for now until you have your build environment set up, let us know if you need help!

Comment 4

[Ashish Namdev]

Hi Margaret  ,

After a long struggle , i am now able to build Fenenc on my machine and also able to run 
robocop tests.

now i can start working on this ,

but need some extension to getting started for this bug.

Thank you 

Ashish N

Comment 5

[:Margaret Leibovic]

(In reply to Ashish Namdev from comment #4)
> Hi Margaret  ,
> 
> After a long struggle , i am now able to build Fenenc on my machine and also
> able to run 
> robocop tests.
> 
> now i can start working on this ,
> 
> but need some extension to getting started for this bug.
> 
> Thank you 
> 
> Ashish N

I'm happy you got your build working! You should follow the links I mentioned in comment 2 to familiarize yourself with robocop and with the Home.panels/HomeProvider APIs.

I think we should start by making a super simple test that adds a panel and checks to make sure that panel is displayed in the home page. This would add a lot of value, so we could land this, then file follow-up bugs to test more parts of the system.

Comment 6

[:Margaret Leibovic]

Attachment: proof of concept

I found this old patch in my patch queue, and you can probably use this as a starting point. I haven't tested it or looked at it closely, so I'm not sure if it's still correct, but the general direction (and file structure) should be what you want.

Comment 7

[Curtis Rasmussen [:Crts]]

Hi Margarget! 

I'd like to start working on this bug. I've already got Firefox for Android building, and I see you've gotten a lot written here, so I should be good to start.

Thanks!

Comment 8

[:Margaret Leibovic]

Excellent! Getting some test coverage here will be really great.

Let me know if you have any questions!

Comment 9

[Curtis Rasmussen [:Crts]]

Attachment: Starting point for Home.panels API tests.

Hi Margaret,

I think I've got what's needed here. I made a mistake when creating my patch so it shows me moving the location in robocop.ini, is there a way to fix this?

Thanks,
Curtis

Comment 10

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

Drive-by!

(In reply to Curtis Rasmussen [:Crts] from comment #9)
> I made a mistake when creating my patch so it shows me moving the
> location in robocop.ini, is there a way to fix this?

With the crecord extension enabled (which I believe has to be downloaded independently from hg), you can use `hg qcrefresh` to update the currently applied patch with changes in your working directory (i.e. what's returned from `hg diff`). However, unlike a `git add -p` where you select individual sections to add (or not) to your changes to be committed, you have to re-evaluate all your changes (i.e. changes already in the patch and changes in the working directory) each time so it can become painfully redundant if used multiple times, but it will get the job done.

I'm not sure if there's a fast way to do this with the default mercurial setup (maybe checking out the previous file's revision and `hg qrefresh`? But I don't know the shortcut to indicate a previous revision).

Maybe Margaret has something better. :)

Comment 11

[:Margaret Leibovic]

(In reply to Michael Comella (:mcomella) from comment #10)
> Drive-by!
> 
> (In reply to Curtis Rasmussen [:Crts] from comment #9)
> > I made a mistake when creating my patch so it shows me moving the
> > location in robocop.ini, is there a way to fix this?
> 
> With the crecord extension enabled (which I believe has to be downloaded
> independently from hg), you can use `hg qcrefresh` to update the currently
> applied patch with changes in your working directory (i.e. what's returned
> from `hg diff`). However, unlike a `git add -p` where you select individual
> sections to add (or not) to your changes to be committed, you have to
> re-evaluate all your changes (i.e. changes already in the patch and changes
> in the working directory) each time so it can become painfully redundant if
> used multiple times, but it will get the job done.
> 
> I'm not sure if there's a fast way to do this with the default mercurial
> setup (maybe checking out the previous file's revision and `hg qrefresh`?
> But I don't know the shortcut to indicate a previous revision).
> 
> Maybe Margaret has something better. :)

Thanks for jumping in, mcomella!

I think you should be able to run `mach mercurial-setup` to get all the mercurial goodness you want. There are some more directions on that here:
https://developer.mozilla.org/en-US/docs/Installing_Mercurial

However, if your patch is showing that you moved the file, there must be another patch applied to your tree (or a commit) that appears before this one, since something must have added that first [testHomePanels] entry. I would just make sure to fold together all of your changes (using `qfold` if you're using mercurial queues).

Comment 12

[:Margaret Leibovic]

Comment on attachment 8525551 [details] [diff] [review]
Starting point for Home.panels API tests.

In the future, you should use the feedback? and review? flags to request feedback/review from other people. And then that person will set feedback+/review+ as appropriate.

I'll flag myself for feedback here, and I'll look at the patch to see if there are any suggestions I have.

Comment 13

[:Margaret Leibovic]

Comment on attachment 8525551 [details] [diff] [review]
Starting point for Home.panels API tests.

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

This is looking good! I think we should just add some assertions on the Java side to make sure the panel was successfully added and removed, and then we can get ready to land this.

Have you been able to run this locally? Once you add these checks and get the test passing locally, I can help you make a push to our try server to make sure this passes on automation.

::: mobile/android/base/tests/testHomePanels.java
@@ +30,5 @@
> +        eventExpecter.blockForEvent();
> +    }
> +
> +    private void addPanel() {
> +        NavigationHelper.enterAndLoadUrl(TEST_URL + "#addPanel");

I would keep this in the same place as the eventExpecter, since this addPanel method would not be very useful without waiting for a message afterwards. The same goes for the removePanel method down below.

Comment 14

[BMO Automation]

We have completed our launch of our new Firefox on Android. The development of the new versions use GitHub for issue tracking. If the bug report still reproduces in a current version of [Firefox on Android nightly](https://play.google.com/store/apps/details?id=org.mozilla.fenix) an issue can be reported at the [Fenix GitHub project](https://github.com/mozilla-mobile/fenix/). If you want to discuss your report please use [Mozilla's chat](https://wiki.mozilla.org/Matrix#Connect_to_Matrix) server https://chat.mozilla.org and join the [#fenix](https://chat.mozilla.org/#/room/#fenix:mozilla.org) channel.