src/cobalt/media_integration_tests/functionality/suspend_resume.py

# Copyright 2021 The Cobalt Authors. All Rights Reserved.
#
# 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.
""" Tests for suspend and resume during playing."""

import logging
import time

import _env  # pylint: disable=unused-import
from cobalt.media_integration_tests.test_app import Features
from cobalt.media_integration_tests.test_case import TestCase
from cobalt.media_integration_tests.test_util import MimeStrings, PlaybackUrls


class SuspendResumeTest(TestCase):
  """
    Test cases for suspend and resume.
  """

  def run_test(self, url, mime=None):
    app = self.CreateCobaltApp(url)
    with app:
      # Skip the test if the mime is not supported.
      if mime and not app.IsMediaTypeSupported(mime):
        logging.info('Mime type (%s) is not supported. Skip the test.', mime)
        return
      # Wait until the playback starts.
      app.WaitUntilPlayerStart()
      app.WaitUntilAdsEnd()
      # Let the playback play for 2 seconds.
      app.WaitUntilMediaTimeReached(app.CurrentMediaTime() + 2)
      # Suspend the app and wait the app enters background.
      logging.info('Suspend the application.')
      app.Suspend()
      app.WaitUntilReachState(
          lambda _app: not _app.ApplicationState().is_visible)
      # Wait for 1 second before resume.
      time.sleep(1)
      # Resume the app and let it play for a few time.
      logging.info('Resume the application.')
      app.Resume()
      app.WaitUntilPlayerStart()
      app.WaitUntilAdsEnd()
      # Let the playback play for 2 seconds.
      app.WaitUntilMediaTimeReached(app.CurrentMediaTime() + 2)


TEST_PARAMETERS = [
    ('H264', PlaybackUrls.H264_ONLY, None),
    ('PROGRESSIVE', PlaybackUrls.PROGRESSIVE, None),
    ('ENCRYPTED', PlaybackUrls.ENCRYPTED, None),
    ('LIVE', PlaybackUrls.LIVE, None),
    ('VP9', PlaybackUrls.VP9, MimeStrings.VP9),
    ('AV1', PlaybackUrls.AV1, MimeStrings.AV1),
    ('VERTICAL', PlaybackUrls.VERTICAL, None),
    ('VR', PlaybackUrls.VR, None),
]

if not TestCase.IsFeatureSupported(Features.SUSPEND_AND_RESUME):
  logging.info('Suspend and resume is not supported on this platform.')
else:
  for name, playback_url, mime_str in TEST_PARAMETERS:
    TestCase.CreateTest(SuspendResumeTest, name, SuspendResumeTest.run_test,
                        playback_url, mime_str)