Error trying run programmatically Appium - Neither ANDROID_HOME nor ANDROID_SDK_ROOT environment variable was exported, using C# and visual studio

Giovanny_Leal · August 11, 2023, 7:39pm

Hello community

I’m working with Appium C# in MacOS environment but when I try run my current code for Android device had as result “Neither ANDROID_HOME nor ANDROID_SDK_ROOT environment variable was exported.Neither ANDROID_HOME nor ANDROID_SDK_ROOT environment variable was exported.”

I verified that environment variables have set correctly and those are correctly set, when I run echo $ANDROID_HOME return me the correct value:

/Users/admin/Library/Android/sdk

I verified too in Visual Studio the configuration and set in Tools - Preferences - SDK Locations - Android and verify in Tools - Preferences - Tools for Unity - General and put the path of Android Studio in the option ‘Preferred Android SDK root’

Specific Error:
OpenQA.Selenium.WebDriverException : An unknown server-side error occurred while processing the command. Original error: Neither ANDROID_HOME nor ANDROID_SDK_ROOT environment variable was exported. Read https://developer.android.com/studio/command-line/variables for more details

Versions
MacOS Ventura: 13.5
Visual Studio 17.6.3
Android Studio 2022.3.1 Giraffe

I hope someone can help me, thank you

Flavio_Di_Carlo · August 12, 2023, 5:31am

Have you added $ANDROID_HOME in $PATH variable?

You can try to run “echo $PATH”.

Giovanny_Leal · August 14, 2023, 2:32pm

I think that $ANDROID_HOME and $PATH are correctly set, on my .zshrc file I have those expectations

#Android_Studio

export ANDROID_HOME=/Users/admin/Library/Android/sdk
export ANDROID_SDK_ROOT=/Users/admin/Library/Android/sdk
export ANDROID_AVD_HOME=/Users/admin/.android/avd
export PATH=$ANDROID_HOME:$PATH
export PATH=$ANDROID_HOME/platform-tools:$PATH
export PATH=$ANDROID_HOME/tools:$PATH
export PATH=$ANDROID_HOME/tools/bin:$PATH

export PATH=$ANDROID_HOME/emulator:$PATH
export PATH=$ANDROID_HOME/sources:$PATH
export PATH=$ANDROID_HOME/bundle-tool:$PATH

#Java

export JAVA_HOME=$(/usr/libexec/java_home)
export PATH=$JAVA_HOME/bin:$PATH

I don’t know if I missing some configuration

Flavio_Di_Carlo · August 21, 2023, 10:02am

Can you write the $PATH value?

Execute echo $PATH in a shell.

mykola-mokhnach · August 21, 2023, 11:53am

github.com

appium/java-client/blob/master/docs/environment.md

# Appium Environment Troubleshooting

Quite often there are questions about why Appium throws an error about missing environment variable, for example `ANDROID_HOME`, or about missing binaries, like `idevice_id`, `carthage` or `java`. 
This article explains what might be a cause of such problem and how to resolve it.

## Prerequisites

In order to understand this topic you should know concept of environment variables, how it works in your operating system and how you can change the system environment if needed. 
In particular, it is important to know the meaning of `PATH` environment variable. Read https://en.wikipedia.org/wiki/Environment_variable and https://en.wikipedia.org/wiki/PATH_(variable) for more details.

## How To Verify What Is Missing

Appium itself is a NodeJS application and uses the same environment as its host `node` process. If you experience an error related to local environment setup then verify the actual process environment first. 
In Mac OS, for example, it is possible to do this via `ps eww <PID>` command, where `PID` is the process identifier of the running Appium's host Node process. 
In Windows the [ProcessExplorer](https://docs.microsoft.com/sysinternals/downloads/process-explorer) utility can be used for such purpose. 
Then make sure the corresponding variable is there and it is set to a proper value, or, in case there is an error finding some binary, make sure the parent folder of this binary is present in `PATH` list, the binary itself on the local file system and can be executed manually.

## How To Fix Missing Environment Variables

Usually, if one starts Appium from the command line, then it inherits all the environment variables from the parent process (`bash`/`cmd`, etc.).

This file has been truncated. show original

Giovanny_Leal · August 22, 2023, 9:53pm

Sure, when I type echo $PATH, I have this result:

Library/Frameworks/Mono.framework/Mono:/Library/Java/JavaVirtualMachines/jdk-20.jdk/Contents/Home/bin:/Users/admin/Library/Android/sdk/bundle-tool:/Users/admin/Library/Android/sdk/sources:/Users/admin/Library/Android/sdk/emulator:/Users/admin/Library/Android/sdk/tools/bin:/Users/admin/Library/Android/sdk/tools:/Users/admin/Library/Android/sdk/platform-tools:/Users/admin/Library/Android/sdk:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/share/dotnet:~/.dotnet/tools:/Library/Apple/usr/bin:/Library/Frameworks/Mono.framework/Versions/Current/Commands:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin

Flavio_Di_Carlo · August 25, 2023, 8:48am

Ok.

If you use Appium Server GUI you have to set the variables there as well

Giovanny_Leal · August 25, 2023, 4:44pm

Hi Flavio thanks for your kind answer.

I checked the configuration and I see that the path correctly of JAVA_HOME and ANDROID_HOME, are similar as you show me.

I don’t know why appears the error when try to run my test from code, when I launch Appium Server Gui and Appium Inspector all works good, but from code doesn’t work.

wreed · August 25, 2023, 5:23pm

This means from Visual Studio, correct? What if you run code from Terminal?

Giovanny_Leal · August 25, 2023, 7:30pm

Yes sir it is from Visual Studio for Mac, I tried run the test cases from Terminal using the dotnet test command and does not appear the error I sailed on the title of the this post

Example command: dotnet test /Users/{YOURPATH}/{YOURPROJECT}.dll

Thanks a lot @wreed and @Flavio_Di_Carlo for your help with this issued I have had

wreed · August 25, 2023, 10:05pm

So just so we are complete, it seems that you just need to add environment variables to your Visual Studio. Here are some instructions to do so:

https://stackoverflow.com/questions/64230782/how-to-set-environment-variables-for-c-sharp-in-vs2019

Giovanny_Leal · August 28, 2023, 2:41pm

Hi @wreed , I applied the answer that show me in StackOverflow but doesn’t work for me

But I continue with this issue, executing from Visual Studio for Mac:

wreed · August 28, 2023, 4:57pm

Well, we’ve established that it’s not an Appium issue. Could try to continue to troubleshoot with Microsoft help:

Or could try another IDE. It’s really up to you.

caesar_zhao · February 5, 2024, 7:19am

I encountered a similar situation on Linux, where after setting up the environment variables, it is necessary to restart Appium. If the terminal in which Appium is running does not update the $ANDROID_HOME variable, the Appium Inspector will keep prompting this error.

wreed · February 5, 2024, 4:50pm

In this case on both Linux and Mac you can restart the shell with this command:

exec $SHELL

Or you can source the shell’s startup scripts where you set the ENV VAR like this:

source <startup_script>

Example: source ~/.bashrc