Include UI tests for blocks through Sample App

[JavonDavis]

We'll need to include an on-device testing solution to help check that everything's good to go as we make changes and include new blocks. I think once we have the following in place we'll be at a good place to start.

CI/CD

• UI testing framework selection Include UI tests for blocks with Appium #676
• UI tests set to run in CI on PRs Include UI tests for blocks with Appium #676

Paragraph block

• Create a short post with a single Paragraph block Include UI tests for blocks with Appium #676
• Create a long post with multiple Paragraph blocks Add paragraph block writing flow tests #821
• Have a paragraph block with a word in it. Place the cursor in the middle of the work and tap "Enter". Verify that the block split into two paragraph blocks, each with the respective half word. Add paragraph block writing flow tests #821
• Have two paragraph blocks with some content in each. Place the cursor at the beginning of the second and tap "Backspace". Verify that the blocks merged. Add paragraph block writing flow tests #821

Image block

• Create a post with a captioned Image block Add image block tests #1060
• Create a post with a captioned Image block followed by multiple paragraph blocks Add image block tests #1060

Heading block

• Create a post with a heading and multiple paragraph blocks Add heading block test #1069

Inserting new blocks

• Have a post with more than a few blocks. Focus the title block and insert a new block via the Inserter. Verify that the block was added at the end of the post and the view scrolled to it.(This does not happen if the post contains a heading block) Add block insertion tests  #1139
• Create a post with a few blocks. Focus on the first block and insert a new block via the inserter. Verify that the block appears in its correct position in the post Add block insertion tests  #1139

I think if we can check off all of these we'll be in a good place to start here.

---

Additional coverage currently includes

• Copy/paste on plain and rich text content in a paragraph block
• Rotating device while adding/removing blocks

[hypest]

Thanks for compiling a list @JavonDavis !

Let's add some writing flow related items. Those are actually the things that are not easy to test in Jest (no access to Aztec itself with no device Jest tests) so it's crucial to add some as baseline to build the testsuite on.

For example:

• Have a paragraph block with a word in it. Place the cursor in the middle of the work and tap "Enter". Verify that the block split in two paragraph blocks, each with the respective half word.
• Have two paragraph blocks with some content in each. Place the cursor at the beginning of the second and tap "Backspace". Verify that the blocks merged.
• Have a post with more than a few blocks. Focus the title block and insert a new block via the Inserter. Verify that the block was added at the end of the post and the view scrolled to it.

What do you think?

[JavonDavis]

Let's add some writing flow related items. Those are actually the things that are not easy to test in Jest (no access to Aztec itself with no device Jest tests) so it's crucial to add some as baseline to build the testsuite on.

Ahh I see, makes sense!

What do you think?

I think the idea behind it is totally correct, it's going to take a little more effort technically to accomplish certain actions though, I'll start looking into it. I'll try and rethink the list to cover the ones you mentioned and more of these sort of writing flows alongside the simple ones I included.

[JavonDavis]

@hypest I'll also mention that this list was just a starting point to build upon, I mainly wanted to have a good base on the code for interacting with all the blocks to see what's possible(reliably) and what's not and then build on from there. Thanks for mentioning the flows because now I'm thinking to just expand this issue to also include items covering those areas to have an idea what interactions we'll need to keep in mind, I'll organize the description into sections and then we can build on a few more flows to have an idea of where we want to be. Does that sound good?

[hypest]

Sounds awesome @JavonDavis . The starting point is good anyway, it's just that I think with on-device testing, it will actually have higher immediate value if we test a couple of flow-related cases instead of going broad (e.g testing all available blocks). We will eventually want to test everything, but to start it's better to focus on flows. 👍

[hypest]

Can we add a task to write a small guide on how to write a new UI (Appium) test? That would help people start adding tests on their own. Thanks!

[JavonDavis]

Can we add a task to write a small guide on how to write a new UI (Appium) test? That would help people start adding tests on their own. Thanks!

Yeah I already started on a separate README file for this, I'll finish this up once we resolve the issues with the merge.

[hypest]

👋 @JavonDavis , I'm thinking, what do you think about adding the following test cases too? For some, my rationale is to help us get some tests in place that exercise our ability to actually test them. Only one test in any of those should be enough to lay the foundation.

• Test that tapping Enter at the end of a Heading block creates a normal paragraph block beneath it
• Include one pasting related test. The simplest could be to paste a two-paragraph text snippet and see that we get two paragraph blocks created.
• Include one device rotation test

[JavonDavis]

my rationale is to help us get some tests in place that exercise our ability to actually test them.

@hypest yeah totally but isn't that the case for what's currently there now? and this would be the aim for all the tests?

The additions you propose sound good! 👍 Could you just clarify what would be the goal for the device rotation test? Just checking that rotating 90 then -90 doesn't break anything?

[JavonDavis]

Yeah I already started on a separate README file for this, I'll finish this up once we resolve the issues with the merge.

As previously mentioned I went the route of adding additional information to the project Wiki which is there now 😄 I'll continue to improve it as we build this out some more and point to it in the project README

[mchowning]

I went the route of adding additional information to the project Wiki which is there now 😄

Nice! 👍

It might be worth adding a link to that Wiki page in the UI Tests section of the README that you added. Hypothetically speaking, someone who was looking at the UI tests recently might have read the README section but not realized there was also a Wiki page regarding the UI tests (that person 100%, most definitely was not me 😁).

[hypest]

my rationale is to help us get some tests in place that exercise our ability to actually test them.

@hypest yeah totally but isn't that the case for what's currently there now? and this would be the aim for all the tests?

👋 @JavonDavis , yeap, that's the case, although notice that I was referring as "For some (of the proposed additions)". Sorry it wasn't clear but, I was mainly referring to the pasting and rotation tests for which we don't have the helper methods in place yet to perform. The goal will be to have the helper functions in place so we use them in future tests. Not sure if it's trivial to perform those operations in Appium as is already.

The additions you propose sound good! 👍 Could you just clarify what would be the goal for the device rotation test? Just checking that rotating 90 then -90 doesn't break anything?

Main goal with that one is to be able to have the rotation feature being performed by the automated test. It would then be super useful to use in other tests, where we will be testing out that things continue to look good, that content is preserved, layout is adjusted and generally, whatever test we can think of. But for the scope of this proposal, we'd only need to do the rotation and test something easy/trivial (block content could be it). Let me know if this clears things up, happy to expand!

[JavonDavis]

@hypest just a heads up that the PRs for the remaining tasks on this list are ready(some might need to be rebased after a few are merged in but nothing major), I'm going to spend some time working with James on reducing the time they take to execute and stability

[rachelmcr]

@JavonDavis I see that all the tasks in the issue description are complete. Can we close this issue? If there is any incomplete work here, perhaps we can move it to a new issue for followup.

[JavonDavis]

@rachelmcr thanks for the ping on this, closing this since the work on this master issue is complete