Add ability to override the log alias directory.

[winterfroststrom]

This change is 

[xpconanfan]

Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 26 at r1 (raw file):

from mobly import utils

LATEST_LOG_ALIAS = 'latest'

When is the appropriate time to call this from a user's perspective?
The log dir is immediately created upon Mobly running right?

[winterfroststrom]

Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 26 at r1 (raw file):

Previously, xpconanfan (Ang Li) wrote…

When is the appropriate time to call this from a user's perspective?
The log dir is immediately created upon Mobly running right?

Before setup_logger from test_runner is called, which basically means in whatever calls test_runner such as the main function.

[xpconanfan]

Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @winterfroststrom)

---

mobly/logger.py, line 26 at r1 (raw file):

Previously, winterfroststrom wrote…

Before setup_logger from test_runner is called, which basically means in whatever calls test_runner such as the main function.

Is there's a way to surface this usage in the official API doc.
Because I doubt many people would even be aware of this "feature" if we don't explicitly surface it.

[winterfroststrom]

Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 26 at r1 (raw file):

Previously, xpconanfan (Ang Li) wrote…

Is there's a way to surface this usage in the official API doc.
Because I doubt many people would even be aware of this "feature" if we don't explicitly surface it.

added something to the docstring of create_latest_log_alias

[xpconanfan]

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 195 at r2 (raw file):

    """Creates a symlink to the latest test run logs.

    The latest log alias directory uses the value of `logger.LATEST_LOG_ALIAS`.

how about "Path to the most recent set of logs uses"

---

mobly/logger.py, line 204 at r2 (raw file):

        actual_path: The source directory where the latest test run's logs are.
    """
    if LATEST_LOG_ALIAS:

actually, should we just make this a param of setup_logger?
would be much easier to document and use?

[winterfroststrom]

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 204 at r2 (raw file):

Previously, xpconanfan (Ang Li) wrote…

actually, should we just make this a param of setup_logger?
would be much easier to document and use?

Well, I was originally thinking of a use case where test_runner isn't directly accessible (from an end user perspective since it's wrapped something else), but I guess it technically is in that use case.
There's a couple different things that this does here though:

1. allow the alias dir to not be created
2. allow getting the name of the alias dir
3. allow changing the alias dir name to something else

I don't see any easy way for (2) without additional changes to the test runner config? Unless we want to assume the end user is using test runner in a way where they can handle that themselves?

[xpconanfan]

Reviewable status: 0 of 2 files reviewed, 3 unresolved discussions (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 204 at r2 (raw file):

Previously, winterfroststrom wrote…

Well, I was originally thinking of a use case where test_runner isn't directly accessible (from an end user perspective since it's wrapped something else), but I guess it technically is in that use case.
There's a couple different things that this does here though:

1. allow the alias dir to not be created
2. allow getting the name of the alias dir
3. allow changing the alias dir name to something else

I don't see any easy way for (2) without additional changes to the test runner config? Unless we want to assume the end user is using test runner in a way where they can handle that themselves?

why is (2) important?
if the user is setting it via params, they should know what they set it to?...

[winterfroststrom]

Reviewable status: 0 of 4 files reviewed, 3 unresolved discussions (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 204 at r2 (raw file):

Previously, xpconanfan (Ang Li) wrote…

why is (2) important?
if the user is setting it via params, they should know what they set it to?...

changed

[xpconanfan]

Reviewable status: 0 of 4 files reviewed, 2 unresolved discussions (waiting on @winterfroststrom)

---

mobly/logger.py, line 213 at r3 (raw file):

            are requested.
        alias: The name of the alias to use for the latest log directory. If a
          falsy value is provided, then the alias directory will not be created.

explain when does it make sense to not create alias?

---

mobly/logger.py, line 218 at r3 (raw file):

    _setup_test_logger(log_path, prefix)
    logging.info('Test output folder: "%s"', log_path)
    create_latest_log_alias(log_path, alias=alias)

how about moving the if alias check here and not call the create alias method?
also remove the default value of alias in create_latest_log_alias

It is a bit odd to allow calling something called "create_latest_log_alias" and not have it do anything...

[winterfroststrom]

Reviewable status: 0 of 4 files reviewed, 2 unresolved discussions (waiting on @winterfroststrom and @xpconanfan)

---

mobly/logger.py, line 213 at r3 (raw file):

Previously, xpconanfan (Ang Li) wrote…

explain when does it make sense to not create alias?

added blurb

---

mobly/logger.py, line 218 at r3 (raw file):

Previously, xpconanfan (Ang Li) wrote…

how about moving the if alias check here and not call the create alias method?
also remove the default value of alias in create_latest_log_alias

It is a bit odd to allow calling something called "create_latest_log_alias" and not have it do anything...

Done.

[xpconanfan]

Reviewable status: 0 of 4 files reviewed, 1 unresolved discussion (waiting on @winterfroststrom)

---

mobly/logger.py, line 194 at r4 (raw file):

    Args:
        actual_path: The source directory where the latest test run's logs are.

the args sections in these two functions are missing the arg type.
Can you add the types...