Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Inconsistent ENV usage across languages is problematic #28

Open
bootstraponline opened this issue Apr 14, 2014 · 6 comments
Open

Inconsistent ENV usage across languages is problematic #28

bootstraponline opened this issue Apr 14, 2014 · 6 comments

Comments

@bootstraponline
Copy link
Contributor

sauce_whisk

ENV['SAUCE_USERNAME'] ||= 'test_user'
ENV['SAUCE_ACCESS_KEY'] ||= 'test_key'

sauce-java

private static final String SAUCE_USER_NAME = "SAUCE_USER_NAME";
private static final String SAUCE_API_KEY = "SAUCE_API_KEY";

I think Sauce should have a standard naming convention for the ENV vars instead of different values for each project.

@bootstraponline
Copy link
Contributor Author

The sauce java client ended up supporting:

  • SAUCE_USER_NAME
  • SAUCE_USERNAME
  • SAUCE_API_KEY
  • SAUCE_ACCESS_KEY

There's still a great deal of inconsistency depending on the clients (most use only two from the above list). The java client is the only one that supports all 4. It'd be good to know what ones are "official."

@jlipps
Copy link
Contributor

jlipps commented May 1, 2015

i don't think Sauce can have any stance on 'official' names for env vars. but i agree that the various clients should endeavor to use the same thing to avoid surprise.

@bootstraponline
Copy link
Contributor Author

Sauce could say here's what we're supporting consistently across the clients instead of using different names in the docs and each language. That's what I meant by 'official.' People run into the same issue with the appium clients. I've settled on SAUCE_USERNAME and SAUCE_ACCESS_KEY since that tends to be used more frequently. If people are using the other names then it's going to break. Ultimately I think the official sauce clients should support all 4 since it's not the users fault there's inconsistency in naming.

@jlipps
Copy link
Contributor

jlipps commented May 1, 2015

fair enough. i think the sauce docs should always use 1 style as an example, and have all the clients support all 4 styles.

@bootstraponline
Copy link
Contributor Author

sounds good to me 👍

@DylanLacey
Copy link
Contributor

I agree it'd be good to at least standardise on what we do it in docs; Personally I like API_KEY but the term ACCESS_KEY is more widely used.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants