1#!/usr/bin/env python
2#
3# Copyright 2008, Google Inc.
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met:
9#
10#     * Redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer.
12#     * Redistributions in binary form must reproduce the above
13# copyright notice, this list of conditions and the following disclaimer
14# in the documentation and/or other materials provided with the
15# distribution.
16#     * Neither the name of Google Inc. nor the names of its
17# contributors may be used to endorse or promote products derived from
18# this software without specific prior written permission.
19#
20# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32"""Verifies that Google Test correctly determines whether to use colors."""
33
34__author__ = 'wan@google.com (Zhanyong Wan)'
35
36import os
37import gtest_test_utils
38
39
40IS_WINDOWS = os.name = 'nt'
41
42COLOR_ENV_VAR = 'GTEST_COLOR'
43COLOR_FLAG = 'gtest_color'
44COMMAND = gtest_test_utils.GetTestExecutablePath('gtest_color_test_')
45
46
47def SetEnvVar(env_var, value):
48  """Sets the env variable to 'value'; unsets it when 'value' is None."""
49
50  if value is not None:
51    os.environ[env_var] = value
52  elif env_var in os.environ:
53    del os.environ[env_var]
54
55
56def UsesColor(term, color_env_var, color_flag):
57  """Runs gtest_color_test_ and returns its exit code."""
58
59  SetEnvVar('TERM', term)
60  SetEnvVar(COLOR_ENV_VAR, color_env_var)
61
62  if color_flag is None:
63    args = []
64  else:
65    args = ['--%s=%s' % (COLOR_FLAG, color_flag)]
66  p = gtest_test_utils.Subprocess([COMMAND] + args)
67  return not p.exited or p.exit_code
68
69
70class GTestColorTest(gtest_test_utils.TestCase):
71  def testNoEnvVarNoFlag(self):
72    """Tests the case when there's neither GTEST_COLOR nor --gtest_color."""
73
74    if not IS_WINDOWS:
75      self.assert_(not UsesColor('dumb', None, None))
76      self.assert_(not UsesColor('emacs', None, None))
77      self.assert_(not UsesColor('xterm-mono', None, None))
78      self.assert_(not UsesColor('unknown', None, None))
79      self.assert_(not UsesColor(None, None, None))
80    self.assert_(UsesColor('linux', None, None))
81    self.assert_(UsesColor('cygwin', None, None))
82    self.assert_(UsesColor('xterm', None, None))
83    self.assert_(UsesColor('xterm-color', None, None))
84    self.assert_(UsesColor('xterm-256color', None, None))
85
86  def testFlagOnly(self):
87    """Tests the case when there's --gtest_color but not GTEST_COLOR."""
88
89    self.assert_(not UsesColor('dumb', None, 'no'))
90    self.assert_(not UsesColor('xterm-color', None, 'no'))
91    if not IS_WINDOWS:
92      self.assert_(not UsesColor('emacs', None, 'auto'))
93    self.assert_(UsesColor('xterm', None, 'auto'))
94    self.assert_(UsesColor('dumb', None, 'yes'))
95    self.assert_(UsesColor('xterm', None, 'yes'))
96
97  def testEnvVarOnly(self):
98    """Tests the case when there's GTEST_COLOR but not --gtest_color."""
99
100    self.assert_(not UsesColor('dumb', 'no', None))
101    self.assert_(not UsesColor('xterm-color', 'no', None))
102    if not IS_WINDOWS:
103      self.assert_(not UsesColor('dumb', 'auto', None))
104    self.assert_(UsesColor('xterm-color', 'auto', None))
105    self.assert_(UsesColor('dumb', 'yes', None))
106    self.assert_(UsesColor('xterm-color', 'yes', None))
107
108  def testEnvVarAndFlag(self):
109    """Tests the case when there are both GTEST_COLOR and --gtest_color."""
110
111    self.assert_(not UsesColor('xterm-color', 'no', 'no'))
112    self.assert_(UsesColor('dumb', 'no', 'yes'))
113    self.assert_(UsesColor('xterm-color', 'no', 'auto'))
114
115  def testAliasesOfYesAndNo(self):
116    """Tests using aliases in specifying --gtest_color."""
117
118    self.assert_(UsesColor('dumb', None, 'true'))
119    self.assert_(UsesColor('dumb', None, 'YES'))
120    self.assert_(UsesColor('dumb', None, 'T'))
121    self.assert_(UsesColor('dumb', None, '1'))
122
123    self.assert_(not UsesColor('xterm', None, 'f'))
124    self.assert_(not UsesColor('xterm', None, 'false'))
125    self.assert_(not UsesColor('xterm', None, '0'))
126    self.assert_(not UsesColor('xterm', None, 'unknown'))
127
128
129if __name__ == '__main__':
130  gtest_test_utils.Main()
131