chromeos-config/cros_config_host/cros_config_host_unittest.py

#!/usr/bin/env python2
# Copyright 2017 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.

"""The unit test suite for the CrosConfigHost CLI tool."""

from __future__ import print_function

import os
import re
import subprocess
import unittest

from . import fdt_util

CLI_FILE = 'python -m cros_config_host.cros_config_host'
DTS_FILE = '../libcros_config/test.dts'
YAML_FILE = '../libcros_config/test.json'


def MakeTests(pathname):
  class CrosConfigHostTest(unittest.TestCase):
    """The unit test suite for the CrosConfigHost CLI tool."""
    def setUp(self):
      self.pathname = pathname
      path = os.path.join(os.path.dirname(__file__), self.pathname)
      if '.dts' in path:
        (self.conf_file, self.temp_file) = fdt_util.EnsureCompiled(path)
      else:
        self.conf_file = path
        self.temp_file = None

    def tearDown(self):
      if self.temp_file is not None:
        os.remove(self.temp_file.name)

    def CheckManyLinesWithoutSpaces(self, output, lines=3):
      # Expect there to be a few lines
      self.assertGreater(len(output.split()), lines)
      # Expect each line to not have spaces in it
      for line in output.split():
        self.assertFalse(' ' in line)
        self.assertNotEqual(line[-1:], ' ')
      # Expect the last thing in the output to be a newline
      self.assertEqual(output[-1:], os.linesep)

    def CheckManyLines(self, output, lines=3):
      # Expect there to be a few lines
      self.assertGreater(len(output.split()), lines)
      # Expect each line to not end in space
      for line in output.split():
        self.assertNotEqual(line[-1:], ' ')
      # Expect the last thing in the output to be a newline
      self.assertEqual(output[-1:], os.linesep)

    def testReadStdin(self):
      yaml = '-y' if 'json' in self.conf_file else ''
      call_args = '{} {} -c - list-models < {}'.format(CLI_FILE, yaml,
                                                       self.conf_file)
      output = subprocess.check_output(call_args, shell=True)
      self.CheckManyLinesWithoutSpaces(output)

    def testListModels(self):
      call_args = '{} -c {} list-models'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.CheckManyLinesWithoutSpaces(output)

    def testListModelsInvalid(self):
      call_args = '{} -c invalid.dtb list-models'.format(CLI_FILE).split()
      with open(os.devnull, 'w') as devnull:
        with self.assertRaises(subprocess.CalledProcessError):
          subprocess.check_call(call_args, stdout=devnull, stderr=devnull)

    def testGetPropSingle(self):
      call_args = '{} -c {} --model=pyro get / wallpaper'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.assertEqual(output, 'default' + os.linesep)

    def testGetPropSingleWrongModel(self):
      call_args = '{} -c {} --model=dne get / wallpaper'.format(
          CLI_FILE, self.conf_file).split()
      # Ensure that the expected error output does not appear.
      output = subprocess.check_output(call_args, stderr=subprocess.PIPE)
      self.assertEqual(output, '')

    def testGetPropSingleWrongPath(self):
      call_args = '{} -c {} --model=pyro get /dne wallpaper'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.assertEqual(output, os.linesep)

    def testGetPropSingleWrongProp(self):
      call_args = '{} -c {} --model=pyro get / dne'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.assertEqual(output, os.linesep)

    def testGetFirmwareUris(self):
      call_args = '{} -c {} --model=pyro get-firmware-uris'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.CheckManyLines(output)

    def testGetTouchFirmwareFiles(self):
      os.environ['DISTDIR'] = 'dist'
      os.environ['FILESDIR'] = 'files'
      call_args = '{} -c {} get-touch-firmware-files'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.CheckManyLines(output, 10)

    def testGetAudioFiles(self):
      call_args = '{} -c {} get-audio-files'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.CheckManyLines(output, 10)

    def testGetFirmwareBuildTargets(self):
      call_args = '{} -c {} get-firmware-build-targets coreboot'.format(
          CLI_FILE, self.conf_file).split()
      output = subprocess.check_output(call_args)
      self.CheckManyLines(output, 1)

    def testWriteTargetDirectories(self):
      """Test that we can write out a list of file paths"""
      call_args = '{} write-target-dirs'.format(CLI_FILE).split()
      output = subprocess.check_output(call_args)
      lines = [line for line in output.splitlines()]
      # Just check for one line, of the form:
      #   alsa-conf = "/usr/share/alsa/ucm";
      alsa_lines = [line for line in lines if 'alsa-conf' in line]
      self.assertEqual(len(alsa_lines), 1)
      m = re.match(r'\s+([-a-z]+) = "(.*)";', alsa_lines[0])
      name, value = m.groups()
      self.assertEqual(name, 'alsa-conf')
      self.assertEqual(value, '/usr/share/alsa/ucm')

    def testWritePhandleProperties(self):
      """Test that we can write out a list of phandle properties"""
      call_args = '{} write-phandle-properties'.format(CLI_FILE).split()
      output = subprocess.check_output(call_args)
      lines = [line for line in output.splitlines()]
      # Find the line of the form:
      #   phandle-properties = ...;
      phandle_props = [line for line in lines if 'phandle-properties' in line]
      self.assertEqual(len(phandle_props), 1)
      m = re.match(r'.* = "(.*)";', phandle_props[0])
      self.assertTrue(m != None)
      props = m.group(0).split('", "')
      self.assertTrue(len(props) > 5)

  return CrosConfigHostTest


class CrosConfigHostTestFdt(MakeTests(DTS_FILE)):
  """Tests for master configuration in device-tree format"""


class CrosConfigHostTestYaml(MakeTests(YAML_FILE)):
  """Tests for master configuration in yaml format"""


if __name__ == '__main__':
  unittest.main()