diff --git a/README.md b/README.md index 22c7be7..60fd6c3 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Please keep in mind that test automation is "only" a side effect of practicing B The opposite is also true. Just because you can't automate a test (tool limitations often prevent you from full automation) it doesn't mean that you shouldn't write the corresponding BDD scenario in collaboration with the team. Scenarios also serve as manual test specs and future improvements to automation tools might allow their implementation. -![overview running on android](docs/android-overview.gif) +![overview running on android](docs/images/android-overview.gif) ### What this is about diff --git a/docs/android-overview.gif b/docs/images/android-overview.gif similarity index 100% rename from docs/android-overview.gif rename to docs/images/android-overview.gif diff --git a/docs/app-example.gif b/docs/images/app-example.gif similarity index 100% rename from docs/app-example.gif rename to docs/images/app-example.gif diff --git a/docs/ellipsis-manual-only.png b/docs/images/ellipsis-manual-only.png similarity index 100% rename from docs/ellipsis-manual-only.png rename to docs/images/ellipsis-manual-only.png diff --git a/docs/success.png b/docs/images/success.png similarity index 100% rename from docs/success.png rename to docs/images/success.png diff --git a/docs/overview.md b/docs/overview.md index 3688bd8..d5219d2 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -14,7 +14,7 @@ Ideally the application needs little code or modification for the purposes of te The app in this sample is a simple one: go to a specific repository on GitHub, show its description, an icon to see if it's public or private and a list of the most recent commits. If you tap on one of the commits, it takes you to a details screen, where you can see further information about that commit. -![app example](app-example.gif) +![app example](images/app-example.gif) ### Mock backend @@ -116,7 +116,7 @@ Some scenarios are more difficult to implement than others. It's good to strike In this sample, we've tagged the 'commit message is too long' scenario as ```@manual-only``` to indicate that it needs to be tested manually. Automating this was very challenging - the scenario verifies that if a commit message is very long, the text becomes ellipsised and truncated, so that each row in the list will be the same height. If we call the 'text' method in Appium on the element, it retrieves the entire string, regardless of the fact the string that's visible to the user is on a single line and correctly ellipsised. UIAutomator, which is what Appium uses on newer versions of Android, only exposes the full text rather than the ellipsised text, which explains why Appium does the same. -![manual only ellipsis scenario](ellipsis-manual-only.png) +![manual only ellipsis scenario](images/ellipsis-manual-only.png) All manual scenarios can be considered technical debt. As a team, we can choose to build up some debt in the form of manual testing AS LONG AS we know we are going to be paying for it whenever we have to release. Additionally, Appium is improving all the time, and in subsequent versions something marked as manual could be very easy. diff --git a/docs/running_tests.md b/docs/running_tests.md index 6142907..a3a8da1 100644 --- a/docs/running_tests.md +++ b/docs/running_tests.md @@ -2,13 +2,13 @@ Please make sure you have gone through [installation and setup](setup.md). ## Running the tests -Use either ```rake android_bdd``` or ```rake ios_bdd``` +Use either ```rake android_bdd``` or ```rake ios_bdd```. With this command we run all of the tests for a particular platform (Android or iOS) that are not tagged as `@manual-only`, since that's what is defined as the default Cucumber profile in `cucumber.yml`. You can read more about why we write scenarios that we know we won't be able to automate in the [codebase comments](testing_codebase_comments.md). We consider everything to be working as expected when a run excluding all the manual tests passes. Test are run sequentially and the results displayed at the end: -![A successful run](success.png) +![A successful run](images/success.png) ### Running specific tests using profiles or tags