#!/usr/bin/python
#
# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.


import argparse, datetime, sys

import common
from autotest_lib.frontend import setup_django_readonly_environment
from autotest_lib.server.cros.dynamic_suite import reporting

# Django and the models are only setup after
# the setup_django_readonly_environment module is imported.
from autotest_lib.frontend.afe import models as afe_models
from autotest_lib.frontend.health import utils as test_health_utils


# Keep tests that have not failed for at least this many days.
_MIN_DAYS_SINCE_FAILURE = 30
# Ignore any tests that have not passed in this many days.
_MAX_DAYS_SINCE_LAST_PASS = 30


def get_experimental_tests():
    """
    Get all the tests marked experimental from the afe_autotests table.

    @return the set of experimental test names.

    """
    entries = afe_models.Test.objects.values('name').filter(experimental=True)
    return {entry['name'] for entry in entries}


def find_long_passing_tests(pass_times, fail_times, valid_names):
    """
    Determine the experimental tests that have been passsing for a long time.

    @param pass_times: The dictionary of test_name:pass_time pairs.
    @param fail_times: The dictionary of test_name:fail_time pairs.
    @param valid_names: An iterable of experimental test names.

    @return the list of experimental test names that have been passing for a
        long time.

    """
    failure_cutoff_date = (datetime.datetime.today() -
                           datetime.timedelta(_MIN_DAYS_SINCE_FAILURE))
    pass_cutoff_date = (datetime.datetime.today() -
                        datetime.timedelta(_MAX_DAYS_SINCE_LAST_PASS))

    valid_passes = {test for test in valid_names if test in pass_times}
    valid_failures = {test for test in valid_names if test in fail_times}

    recent_passes = {test for test in valid_passes
                     if (pass_times[test] > pass_cutoff_date)}
    recent_fails = {test for test in valid_failures
                    if (fail_times[test] > failure_cutoff_date)}

    return recent_passes - recent_fails


def parse_options(args):
    """Parse the command line options."""

    description = ('Collects information about which experimental tests '
                   'have been passing for a long time and creates a bug '
                   'report for each one.')
    parser = argparse.ArgumentParser(description=description)
    parser.parse_args(args)


def submit_bug_reports(tests):
    """
    Submits bug reports to make the long passing tests as not experimental.

    @param tests: The tests that need to be marked as not experimental.
    """

    for test in tests:
        title = '%s should be promoted to non-experimental.' % test
        summary = ('This bug has been automatically filed to track the '
                   'following issue:\n\n'
                   'Test: %s\n'
                   'Issue: Promote to non-experimental as it has been passing '
                   'for at least %d days.\n'
                   'Suggested Actions: Navigate to the test\'s control file '
                   'and remove the EXPERIMENTAL flag.\n'
                   '\tSee http://www.chromium.org/chromium-os/testing/'
                   'autotest-best-practices#TOC-Control-files' %
                   (test, _MIN_DAYS_SINCE_FAILURE))
        search_marker = 'PassingExperimental(%s)' % test
        reporting.submit_generic_bug_report(title=title, summary=summary,
                                            search_marker=search_marker)


def main(args=None):
    """
    The script code.

    Allows other python code to import and run this code. This will be more
    important if a nice way to test this code can be determined.

    @param args: The command line arguments being passed in.

    """
    args = [] if args is None else args
    parse_options(args)

    experimental_tests = get_experimental_tests()
    pass_times = test_health_utils.get_last_pass_times()
    fail_times = test_health_utils.get_last_fail_times()

    long_passers = find_long_passing_tests(pass_times, fail_times,
                                           experimental_tests)

    submit_bug_reports(long_passers)

    return 0


if __name__ == '__main__':
    sys.exit(main(sys.argv[1:]))