Adding HTML5 track(caption) test case in PyAuto media functional tests.

chrome/test/functional/media/media_test_runner.py

 #!/usr/bin/python
 # Copyright (c) 2011 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """A module to execute a subclass of MediaTastBase class.
 
 This executes a media test class (a subclass of MediaTastBase class) with
 different configuration (parameters) which are passed in the form of
 environment variables (e.g., the number of runs). The location of the
@@ skipping 91 matching lines @@
       default='', help='Test scenario file (CSV form)', metavar='FILE')
   parser.add_option(
       '-q', '--test_scenario', dest='test_scenario',
       default='', help='Test scenario (action triples delimited by \'|\')')
   parser.add_option('-s', '--suite', dest='suite',
                     help='Suite file')
   parser.add_option('-e', '--media_file', dest='media_file',
                     default='',
                     help=('Media file to be played using player.html. '
                           'The relative path needs to be specified starting '
-                          'from data/html/ directory.'))
+                          'from data/html/ directory.'

[dennis_jeffrey, 2011/06/13 22:51:49]

Nit: put a space right before the closing quote.

[imasaki1, 2011/06/13 23:43:09]

Done.

+                          'The data should have the following format:'

[dennis_jeffrey, 2011/06/13 22:51:49]

Nit: put a space right before the closing quote.

[imasaki1, 2011/06/13 23:43:09]

Done.

+                          'tag(video|audio)|filename|nickname|video_title'))
   parser.add_option('-a', '--reference_build', dest='reference_build',
                     help='Include reference build run', default=False,
                     action='store_true')
   parser.add_option('-k', '--reference_build_dir', dest='reference_build_dir',
                     help=('A absolute path to the directory that contains'
                           'binaries of reference build.'))
   parser.add_option('-v', '--verbose', dest='verbose', help='Verbose mode.',
                     default=False, action='store_true')
   parser.add_option('-j', '--track', dest='track',
                     help=('Run track test (binary should be downloaded'
                           ' from http://www.annacavender.com/track/'
                           ' and put into reference_build_dir).'),
                     default=False, action='store_true')
+  parser.add_option('-g', '--track-file', dest='track_file',
+                    help=('Track file in vtt format (binary should be'
+                          ' downloaded from http://www.annacavender.com/track/'
+                          ' and put into reference_build_dir).'))
+
   options, args = parser.parse_args()
   if args:
     parser.print_help()
     sys.exit(1)
 
   test_data_list = []
   if options.media_file:
-    test_data_list.append(['video', options.media_file, options.media_file])
+    opts = options.media_file.split('|')
+    # media file should have the following format:

[dennis_jeffrey, 2011/06/13 22:51:49]

nit: "media file" --> "The media file"

[imasaki1, 2011/06/13 23:43:09]

Done.

+    # tag(video|audio)|filename|nickname|video_title.
+    # Otherwise, it exits.

[Nirnimesh, 2011/06/13 22:07:37]

remove this line

[imasaki1, 2011/06/13 23:43:09]

Done.

+    if len(opts) != 4:

[Nirnimesh, 2011/06/13 22:07:37]

print out some helpful error message

[imasaki1, 2011/06/13 23:43:09]

Done.

+      sys.exit(1)
+    test_data_list.append(opts)
   elif options.input_matrix_filename is None:
     file = open(options.input_filename, 'rb')
     test_data_list = csv.reader(file)
     # First line contains headers that can be skipped.
     test_data_list.next()
   else:
     # Video_matrix_home_url requires "/" at the end.
     if not options.video_matrix_home_url.endswith('/'):
       options.video_matrix_home_url += '/'
     media_test_matrix = MediaTestMatrix()
     media_test_matrix.ReadData(options.input_matrix_filename)
     all_data_list = media_test_matrix.GenerateAllMediaInfosInCompactForm(
         True, options.video_matrix_home_url)
     if options.input_matrix_testcase_name is None:
       # Use all test cases.
       test_data_list = all_data_list
     else:
       # Choose particular video.
       media_info = MediaTestMatrix.LookForMediaInfoInCompactFormByNickName(
           all_data_list, options.input_matrix_testcase_name)
       if media_info is not None:
         test_data_list.append(media_info)
 
   # Determine whether we need to repeat a test using a reference build.
   # The default is not to include a test using a reference build.
   if options.reference_build:
     reference_build_list = [False, True]
   else:
     reference_build_list = [False]
-  if options.track:
+  if options.track_file or options.track:
     # TODO(imasaki@chromium.org): change here after track functionality is
     # available on Chrome. Currently, track patch is still under development.
     # So, I need to download the binary from
     # http://www.annacavender.com/track/ and use it for testing.
     # I temporarily use reference build mechanism.
     reference_build_list = [True]
   # This is a loop for iterating through all videos defined above (list
   # or matrix). Each video has associated tag and nickname for display
   # purpose.
-  for tag, filename, nickname in test_data_list:
+  for tag, filename, nickname, title in test_data_list:
       # This inner loop iterates twice. The first iteration of the loop
       # disables the media cache, and the second iteration enables the media
       # cache.  Other parameters remain the same on both loop iterations.
       # There are two ways to disable the media cache: setting Chrome option
       # to --media-cache-size=1 or adding t parameter in query parameter of
       # URL in which player.js (data/media/html/player.js) disables the
       # media cache).
+      #
+      # The default name for track vtt file is the name of the video tile

[dennis_jeffrey, 2011/06/13 22:51:49]

"tile" -->
"title"

[imasaki1, 2011/06/13 23:43:09]

Done.

+      # in the case --track-file is not set. The track file should be in
+      # the same directory as video files.
+      # For example, bear_en.vtt used

[dennis_jeffrey, 2011/06/13 22:51:49]

Remove "used"?

[imasaki1, 2011/06/13 23:43:09]

Done.

+      if options.track and not options.track_file:
+        # TODO(imasaki@chromium.org): add more languages.
+        lang = 'en'
+        options.track_file = os.path.join(os.path.dirname(filename),
+                                          title + '_' + lang + '.vtt')
       for reference_build in reference_build_list:
         parent_envs = copy.deepcopy(os.environ)
         if options.input_matrix_filename is None:
           par_filename = os.path.join(os.pardir, filename)
         else:
           par_filename = filename
         envs = {
           MediaTestEnvNames.MEDIA_TAG_ENV_NAME: tag,
           MediaTestEnvNames.MEDIA_FILENAME_ENV_NAME: par_filename,
           MediaTestEnvNames.MEDIA_FILENAME_NICKNAME_ENV_NAME: nickname,
@@ skipping 17 matching lines @@
               options.disable_media_cache)
         if reference_build:
           envs[MediaTestEnvNames.REFERENCE_BUILD_ENV_NAME] = str(
               reference_build)
         if REMOVE_FIRST_RESULT:
           envs[MediaTestEnvNames.REMOVE_FIRST_RESULT_ENV_NAME] = str(
               REMOVE_FIRST_RESULT)
         if options.reference_build_dir:
           envs[MediaTestEnvNames.REFERENCE_BUILD_DIR_ENV_NAME] = (
               options.reference_build_dir)
+        if options.track_file:
+          envs[MediaTestEnvNames.TRACK_FILE_ENV_NAME] = (
+              options.track_file)
         envs.update(parent_envs)
         if options.suite is None and options.test_prog_name is not None:
           # Suite is not used - run test program directly.
           test_prog_name = options.test_prog_name
           suite_string = ''
         else:
           # Suite is used.
           # The test script names are in the PYAUTO_TESTS file.
           test_prog_name = pyauto_functional_script_name
           if options.suite is None:
             suite_name = DEFAULT_SUITE_NAME
           else:
             suite_name = options.suite
           suite_string = ' --suite=%s' % suite_name
         test_prog_name = sys.executable + ' ' + test_prog_name
         chrome_flag = ''
         if options.disable_media_cache:
           chrome_flag += CHROME_FLAGS['disable_cache']
-        if options.track:
+        if options.track_file:
           if options.disable_media_cache:
             chrome_flag += ' '
           chrome_flag += CHROME_FLAGS['track']
         if chrome_flag:
           chrome_flag = '--chrome-flags=\'%s\'' % chrome_flag
         cmd = test_prog_name + suite_string + ' ' + chrome_flag
         if options.verbose:
           cmd += ' -v'
         proc = Popen(cmd, env=envs, shell=True)
         proc.communicate()
 
       if options.one_video:
         break
 
 
 if __name__ == '__main__':
   main()