# vim: tabstop=4 shiftwidth=4 softtabstop=4 # Copyright 2010 United States Government as represented by the # Administrator of the National Aeronautics and Space Administration. # All Rights Reserved. # Copyright 2011 Red Hat, Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import os import tempfile import unittest import gflags from quantum.common import flags FLAGS = flags.FLAGS flags.DEFINE_string('flags_unittest', 'foo', 'for testing purposes only') class FlagsTestCase(unittest.TestCase): def flags(self, **kw): """Override flag variables for a test.""" for k, v in kw.iteritems(): setattr(FLAGS, k, v) def reset_flags(self): """Resets all flag variables for the test. Runs after each test. """ FLAGS.Reset() for k, v in self._original_flags.iteritems(): setattr(FLAGS, k, v) def setUp(self): super(FlagsTestCase, self).setUp() self.FLAGS = flags.FlagValues() self.global_FLAGS = flags.FLAGS self._original_flags = FLAGS.FlagValuesDict() def test_define(self): self.assert_('string' not in self.FLAGS) self.assert_('int' not in self.FLAGS) self.assert_('false' not in self.FLAGS) self.assert_('true' not in self.FLAGS) flags.DEFINE_string('string', 'default', 'desc', flag_values=self.FLAGS) flags.DEFINE_integer('int', 1, 'desc', flag_values=self.FLAGS) flags.DEFINE_bool('false', False, 'desc', flag_values=self.FLAGS) flags.DEFINE_bool('true', True, 'desc', flag_values=self.FLAGS) self.assert_(self.FLAGS['string']) self.assert_(self.FLAGS['int']) self.assert_(self.FLAGS['false']) self.assert_(self.FLAGS['true']) self.assertEqual(self.FLAGS.string, 'default') self.assertEqual(self.FLAGS.int, 1) self.assertEqual(self.FLAGS.false, False) self.assertEqual(self.FLAGS.true, True) argv = ['flags_test', '--string', 'foo', '--int', '2', '--false', '--notrue'] self.FLAGS(argv) self.assertEqual(self.FLAGS.string, 'foo') self.assertEqual(self.FLAGS.int, 2) self.assertEqual(self.FLAGS.false, True) self.assertEqual(self.FLAGS.true, False) def test_define_float(self): flags.DEFINE_float('float', 6.66, 'desc', flag_values=self.FLAGS) self.assertEqual(self.FLAGS.float, 6.66) def test_define_multistring(self): flags.DEFINE_multistring('multi', [], 'desc', flag_values=self.FLAGS) argv = ['flags_test', '--multi', 'foo', '--multi', 'bar'] self.FLAGS(argv) self.assertEqual(self.FLAGS.multi, ['foo', 'bar']) def test_define_list(self): flags.DEFINE_list('list', ['foo'], 'desc', flag_values=self.FLAGS) self.assert_(self.FLAGS['list']) self.assertEqual(self.FLAGS.list, ['foo']) argv = ['flags_test', '--list=a,b,c,d'] self.FLAGS(argv) self.assertEqual(self.FLAGS.list, ['a', 'b', 'c', 'd']) def test_error(self): flags.DEFINE_integer('error', 1, 'desc', flag_values=self.FLAGS) self.assertEqual(self.FLAGS.error, 1) argv = ['flags_test', '--error=foo'] self.assertRaises(gflags.IllegalFlagValue, self.FLAGS, argv) def test_declare(self): self.assert_('answer' not in self.global_FLAGS) flags.DECLARE('answer', 'quantum.tests.unit.declare_flags') self.assert_('answer' in self.global_FLAGS) self.assertEqual(self.global_FLAGS.answer, 42) # Make sure we don't overwrite anything self.global_FLAGS.answer = 256 self.assertEqual(self.global_FLAGS.answer, 256) flags.DECLARE('answer', 'quantum.tests.unit.declare_flags') self.assertEqual(self.global_FLAGS.answer, 256) def test_getopt_non_interspersed_args(self): self.assert_('runtime_answer' not in self.global_FLAGS) argv = ['flags_test', 'extra_arg', '--runtime_answer=60'] args = self.global_FLAGS(argv) self.assertEqual(len(args), 3) self.assertEqual(argv, args) def test_runtime_and_unknown_flags(self): self.assert_('runtime_answer' not in self.global_FLAGS) argv = ['flags_test', '--runtime_answer=60', 'extra_arg'] args = self.global_FLAGS(argv) self.assertEqual(len(args), 2) self.assertEqual(args[1], 'extra_arg') self.assert_('runtime_answer' not in self.global_FLAGS) import quantum.tests.unit.runtime_flags self.assert_('runtime_answer' in self.global_FLAGS) self.assertEqual(self.global_FLAGS.runtime_answer, 60) def test_flag_overrides(self): self.assertEqual(FLAGS.flags_unittest, 'foo') self.flags(flags_unittest='bar') self.assertEqual(FLAGS.flags_unittest, 'bar') self.assertEqual(FLAGS['flags_unittest'].value, 'bar') self.assertEqual(FLAGS.FlagValuesDict()['flags_unittest'], 'bar') self.reset_flags() self.assertEqual(FLAGS.flags_unittest, 'foo') self.assertEqual(FLAGS['flags_unittest'].value, 'foo') self.assertEqual(FLAGS.FlagValuesDict()['flags_unittest'], 'foo') def test_flagfile(self): flags.DEFINE_string('string', 'default', 'desc', flag_values=self.FLAGS) flags.DEFINE_integer('int', 1, 'desc', flag_values=self.FLAGS) flags.DEFINE_bool('false', False, 'desc', flag_values=self.FLAGS) flags.DEFINE_bool('true', True, 'desc', flag_values=self.FLAGS) (fd, path) = tempfile.mkstemp(prefix='nova', suffix='.flags') try: os.write(fd, '--string=foo\n--int=2\n--false\n--notrue\n') os.close(fd) self.FLAGS(['flags_test', '--flagfile=' + path]) self.assertEqual(self.FLAGS.string, 'foo') self.assertEqual(self.FLAGS.int, 2) self.assertEqual(self.FLAGS.false, True) self.assertEqual(self.FLAGS.true, False) finally: os.remove(path) def test_defaults(self): flags.DEFINE_string('foo', 'bar', 'help', flag_values=self.FLAGS) self.assertEqual(self.FLAGS.foo, 'bar') self.FLAGS['foo'].SetDefault('blaa') self.assertEqual(self.FLAGS.foo, 'blaa') def test_templated_values(self): flags.DEFINE_string('foo', 'foo', 'help', flag_values=self.FLAGS) flags.DEFINE_string('bar', 'bar', 'help', flag_values=self.FLAGS) flags.DEFINE_string('blaa', '$foo$bar', 'help', flag_values=self.FLAGS) self.assertEqual(self.FLAGS.blaa, 'foobar')