xamarin/Xamarin.Forms

[README] Add more information about getting UI tests running

Open

#5,877 opened on Apr 10, 2019

View on GitHub
 (2 comments) (5 reactions) (0 assignees)C# (5,644 stars) (1,926 forks)batch import
e/1 :clock1:good first issuehacktoberfest 🍻help wantedt/housekeeping ♻︎up-for-grabs

Description

I have to say. It took a while before my environment was ready. There are some things missing in the "getting started" section. Especially for running UITest.

First problem was that the test weren't discovered.

  • Either install older version of nunit test adapter extension
  • Or change a setting in Visual Studio I changed the setting in Visual Studio and it worked (due to the fact the correct nunit nuget packages were already added to the project).

Then came another problem while running the UITest. It complained there was no ANDROID_HOME environment variable. Fixed that by adding it.

Then when running the UITest, it complained about not finding the adb. Something todo with mismatching sdk versions. After a quick google I found this: Getting your xamarin uitests to actually work. So I downgraded the platform tools and it finally worked. If that didn't worked, I would have just given up. It was just not worth the hassle.

If all those things were properly documented as possible pittfalls and available in the "getting started" section, it would help alot of starting contributers like me.

Originally posted by @puppetSpace in https://github.com/xamarin/Xamarin.Forms/issues/2381#issuecomment-481236329

Contributor guide

Tech stack
csharpandroid
Domain
documentationtestingmobile
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Xamarin.Forms basicsAndroid SDK setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Research the current README for getting started, especially the UI testing section. Identify missing steps such as setting ANDROID HOME, installing correct NUnit test adapter, and handling adb version mismatches. Add these as pitfalls in the documentation. Refer to the linked blog post for details.