test_flintrock.py

import os

# External modules
import pytest

# Flintrock modules
from flintrock.exceptions import (
    Error,
    UsageError,
)
from flintrock.flintrock import (
    option_name_to_variable_name,
    variable_name_to_option_name,
    option_requires,
    mutually_exclusive,
    get_latest_commit,
    validate_download_source,
    normalize_keys,
)


def test_option_name_to_variable_name_conversions():
    test_cases = [
        ('--ec2-user', 'ec2_user'),
        ('--provider', 'provider'),
        ('--spark-git-commit', 'spark_git_commit')
    ]

    for option_name, variable_name in test_cases:
        assert option_name_to_variable_name(option_name) == variable_name
        assert variable_name_to_option_name(variable_name) == option_name
        assert option_name == variable_name_to_option_name(
            option_name_to_variable_name(option_name))
        assert variable_name == option_name_to_variable_name(
            variable_name_to_option_name(variable_name))


def test_option_requires():
    some_option = 'something'
    unset_option = None
    set_option = '와 짠이다'

    option_requires(
        option='--some-option',
        requires_all=['--set_option'],
        scope=locals()
    )

    option_requires(
        option='--some-option',
        requires_any=[
            '--set_option',
            '--unset-option'],
        scope=locals()
    )

    with pytest.raises(UsageError):
        option_requires(
            option='--some-option',
            requires_all=[
                '--set-option',
                '--unset-option'],
            scope=locals()
        )

    with pytest.raises(UsageError):
        option_requires(
            option='--some-option',
            requires_any=[
                '--unset-option'],
            scope=locals()
        )


def test_option_requires_conditional_value():
    unset_option = None
    set_option = '대박'

    some_option = 'magic'
    option_requires(
        option='--some-option',
        conditional_value='magic',
        requires_any=[
            '--set-option',
            '--unset-option'],
        scope=locals()
    )

    some_option = 'not magic'
    option_requires(
        option='--some-option',
        conditional_value='magic',
        requires_any=[
            '--unset-option'],
        scope=locals()
    )

    some_option = ''
    option_requires(
        option='--some-option',
        conditional_value='',
        requires_any=[
            '--unset-option'],
        scope=locals()
    )

    with pytest.raises(UsageError):
        some_option = 'magic'
        option_requires(
            option='--some-option',
            conditional_value='magic',
            requires_any=[
                '--unset-option'],
            scope=locals()
        )


def test_mutually_exclusive():
    option1 = 'yes'
    option2 = None

    mutually_exclusive(
        options=[
            '--option1',
            '--option2'],
        scope=locals())

    option2 = 'no'
    with pytest.raises(UsageError):
        mutually_exclusive(
            options=[
                '--option1',
                '--option2'],
            scope=locals())


@pytest.mark.xfail(
    reason="This may fail on CI with HTTP Error 403: rate limit exceeded.",
    raises=Exception,
    condition=(os.environ.get('CI') == 'true'),
)
def test_get_latest_commit():
    sha = get_latest_commit("https://github.com/apache/spark")
    assert len(sha) == 40

    with pytest.raises(UsageError):
        get_latest_commit("https://google.com")

    with pytest.raises(Exception):
        get_latest_commit("https://github.com/apache/nonexistent-repo")


@pytest.mark.xfail(
    reason=(
        "This test will fail whenever a new Hadoop or Spark "
        "release is made, which is out of our control."
    ),
    raises=Error,
)
def test_validate_valid_download_source():
    validate_download_source("https://www.apache.org/dyn/closer.lua?action=download&filename=hadoop/common/hadoop-3.3.6/hadoop-3.3.6.tar.gz")
    validate_download_source("https://www.apache.org/dyn/closer.lua?action=download&filename=spark/spark-3.5.0/spark-3.5.0-bin-hadoop3.tgz")


def test_validate_invalid_download_source():
    with pytest.raises(Error):
        validate_download_source("https://www.apache.org/dyn/closer.lua?action=download&filename=hadoop/common/hadoop-invalid-version/hadoop-invalid-version.tar.gz")


def test_normalize_keys():
    config_file_settings = {
        "java-version": 11,
        "ec2": {
            "spot-price": 0.05,
            "key-name": "key.pem",
        },
        "tags": ["name, test-cluster"],
    }
    cli_settings = {
        "java_version": 11,
        "ec2": {
            "spot_price": 0.05,
            "key_name": "key.pem",
        },
        "tags": ["name, test-cluster"],
    }
    assert normalize_keys(config_file_settings) == cli_settings