oss-fuzz/infra/cifuzz/config_utils_test.py

# Copyright 2021 Google LLC
#
# 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 config_utils."""
import os
import unittest
from unittest import mock

import config_utils
import constants
import test_helpers

# pylint: disable=no-self-use,protected-access


class BaseConfigTest(unittest.TestCase):
  """Tests for BaseConfig."""

  def setUp(self):
    test_helpers.patch_environ(self)

  def _create_config(self):
    return config_utils.BuildFuzzersConfig()

  def test_language_default(self):
    """Tests that the correct default language is set."""
    config = self._create_config()
    self.assertEqual(config.language, 'c++')

  def test_language(self):
    """Tests that the correct language is set."""
    language = 'python'
    os.environ['LANGUAGE'] = language
    config = self._create_config()
    self.assertEqual(config.language, language)

  def test_is_coverage(self):
    """Tests that is_coverage is set correctly."""
    # Test it is set when it is supposed to be.
    os.environ['SANITIZER'] = 'coverage'
    config = self._create_config()
    self.assertTrue(config.is_coverage)

    # Test it is not set when it is not supposed to be.
    os.environ['SANITIZER'] = 'address'
    config = self._create_config()
    self.assertFalse(config.is_coverage)

  @mock.patch('logging.error')
  def test_validate_no_workspace(self, mock_error):
    """Tests that validate returns False if GITHUB_WORKSPACE isn't set."""
    os.environ['OSS_FUZZ_PROJECT_NAME'] = 'example'
    config = self._create_config()
    self.assertFalse(config.validate())
    mock_error.assert_called_with('Must set WORKSPACE.')

  @mock.patch('logging.error')
  def test_validate_invalid_language(self, mock_error):
    """Tests that validate returns False if GITHUB_WORKSPACE isn't set."""
    os.environ['OSS_FUZZ_PROJECT_NAME'] = 'example'
    os.environ['WORKSPACE'] = '/workspace'
    os.environ['LANGUAGE'] = 'invalid-language'
    config = self._create_config()
    self.assertFalse(config.validate())
    mock_error.assert_called_with('Invalid LANGUAGE: %s. Must be one of: %s.',
                                  os.environ['LANGUAGE'], constants.LANGUAGES)

  @mock.patch('logging.error')
  def test_validate_invalid_sanitizer(self, mock_error):
    """Tests that validate returns False if GITHUB_WORKSPACE isn't set."""
    os.environ['OSS_FUZZ_PROJECT_NAME'] = 'example'
    os.environ['WORKSPACE'] = '/workspace'
    os.environ['SANITIZER'] = 'invalid-sanitizer'
    config = self._create_config()
    self.assertFalse(config.validate())
    mock_error.assert_called_with('Invalid SANITIZER: %s. Must be one of: %s.',
                                  os.environ['SANITIZER'],
                                  config_utils.SANITIZERS)

  def test_validate(self):
    """Tests that validate returns True if config is valid."""
    os.environ['OSS_FUZZ_PROJECT_NAME'] = 'example'
    os.environ['WORKSPACE'] = '/workspace'
    os.environ['REPOSITORY'] = 'repo'
    config = self._create_config()
    self.assertTrue(config.validate())


class BuildFuzzersConfigTest(unittest.TestCase):
  """Tests for BuildFuzzersConfig."""

  def setUp(self):
    test_helpers.patch_environ(self)

  def _create_config(self):
    return config_utils.BuildFuzzersConfig()

  @mock.patch('platform_config.github._get_event_data', return_value={})
  def test_github_base_ref(self, _):
    """Tests that base_ref is set properly."""
    expected_base_ref = 'expected_base_ref'
    os.environ['GITHUB_BASE_REF'] = expected_base_ref
    os.environ['CFL_PLATFORM'] = 'github'
    os.environ['GITHUB_REPOSITORY'] = 'owner/repo'
    config = self._create_config()
    self.assertEqual(config.base_ref, expected_base_ref)

  def test_base_ref(self):
    """Tests that base_ref is set properly."""
    expected_base_ref = 'expected_base_ref'
    os.environ['GIT_BASE_REF'] = expected_base_ref
    config = self._create_config()
    self.assertEqual(config.base_ref, expected_base_ref)

  def test_keep_unaffected_defaults_to_true(self):
    """Tests that keep_unaffected_fuzz_targets defaults to true."""
    config = self._create_config()
    self.assertTrue(config.keep_unaffected_fuzz_targets)

  def test_keep_unaffected_defaults_to_false_when_pr(self):
    """Tests that keep_unaffected_fuzz_targets defaults to false when from a
    pr."""
    os.environ['GIT_BASE_REF'] = 'base-ref'
    config = self._create_config()
    self.assertFalse(config.keep_unaffected_fuzz_targets)


class RunFuzzersConfigTest(unittest.TestCase):
  """Tests for RunFuzzersConfig."""

  def setUp(self):
    test_helpers.patch_environ(self)

  def _create_config(self):
    return config_utils.RunFuzzersConfig()

  def test_coverage(self):
    """Tests that mode is overriden properly based on is_coverage."""
    # Test that it is overriden when it is supposed to be.
    os.environ['SANITIZER'] = 'coverage'
    os.environ['MODE'] = 'code-change'
    config = self._create_config()
    self.assertEqual(config.mode, 'coverage')

    # Test that it isn't overriden when it isn't supposed to be.
    os.environ['SANITIZER'] = 'address'
    mode = 'code-change'
    os.environ['MODE'] = mode
    config = self._create_config()
    self.assertEqual(config.mode, mode)

  def test_run_config_validate(self):
    """Tests that _run_config_validate returns True when the config is valid."""
    self.assertTrue(self._create_config()._run_config_validate())

  @mock.patch('logging.error')
  def test_run_config_invalid_mode(self, mock_error):
    """Tests that _run_config_validate returns False when mode is invalid."""
    fake_mode = 'fake-mode'
    os.environ['MODE'] = fake_mode
    self.assertFalse(self._create_config()._run_config_validate())
    mock_error.assert_called_with('Invalid MODE: %s. Must be one of %s.',
                                  fake_mode,
                                  config_utils.RunFuzzersConfig.MODES)


class GetSanitizerTest(unittest.TestCase):
  """Tests for _get_sanitizer."""

  def setUp(self):
    test_helpers.patch_environ(self)
    self.sanitizer = 'memory'

  def test_default_value(self):
    """Tests that the default value returned by _get_sanitizer is correct."""
    self.assertEqual(config_utils._get_sanitizer(), 'address')

  def test_normal_case(self):
    """Tests that _get_sanitizer returns the correct value in normal cases."""
    os.environ['SANITIZER'] = self.sanitizer
    self.assertEqual(config_utils._get_sanitizer(), self.sanitizer)

  def test_capitalization(self):
    """Tests that that _get_sanitizer handles capitalization properly."""
    os.environ['SANITIZER'] = self.sanitizer.upper()
    self.assertEqual(config_utils._get_sanitizer(), self.sanitizer)


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