gen_context_data_inputs_expected()

Complexity

Conditions

1

Size

Total Lines

433

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

# -*- coding: utf-8 -*-
def gen_context_data_inputs_expected():
    # Extra field ignored
    context_with_valid_extra_0 = (
        {
            'context_file': 'tests/test-generate-context-v2/test.json',
            'extra_context': [
                {
                    'name': 'email',
                    'default': 'miles.davis@jazz.gone',
                    'description': 'Enter jazzy email...',
                    'extra_field': 'extra_field_value',
                }
            ]
        },
        {
            "test": OrderedDict([
                ("name", "cookiecutter-pytest-plugin"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "full_name"),
                        ("default", "J. Paul Getty"),
                        ("prompt", "What's your full name?"),
                        ("description", "Please enter your full name. It will be displayed on the README file and used for the PyPI package definition."),
                        ("type", "string")]),
                    OrderedDict([
                        ("name", "email"),
                        ("default", "miles.davis@jazz.gone"),
                        ("prompt", "What's your email?"),
                        ("description", "Enter jazzy email..."),
                        ("type", "string")]),
                ])
            ])
        }
    )
    # Empty extra context precipitates no ill effect
    context_with_valid_extra_1 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': []
            # 'extra_context': [
            #     {
            #         'name': 'email',
            #         'default': 'miles.davis@jazz.gone',
            #         'description': 'Enter jazzy email...',
            #         'extra_field': 'extra_field_value',
            #     }
            # ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Allan Smithe"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ["Allan Smithe", "Ridley Scott", "Victor Fleming", "John Houston"]),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )

    # Test the ability to change the variable's name field (since it is used
    # to identify the variable to be modifed) with extra context and to remove
    # a key from the context via the removal token: '<<ACTION::REMOVE>>'
    context_with_valid_extra_2 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_credit::producer_credit',
                    'prompt': 'Is there a producer credit on this film?',
                    'description': 'There are usually a lot of producers...',
                },
                {
                    'name': 'director_name',
                    'skip_if': '<<REMOVE::FIELD>>',
                },

            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "producer_credit"),
                        ("default", True),
                        ("prompt", "Is there a producer credit on this film?"),
                        ("description", "There are usually a lot of producers..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Allan Smithe"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ["Allan Smithe", "Ridley Scott", "Victor Fleming", "John Houston"]),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test the ability to change the variable's name field (since it is used
    # to identify the variable to be modifed) with extra context and to also
    # test that any other references in other variables that might use the
    # original variable name get updated as well.
    context_with_valid_extra_2_B = (
        {
            'context_file': 'tests/test-generate-context-v2/representative_2B.json',
            'extra_context': [
                {
                    'name': 'director_credit::producer_credit',
                    'prompt': 'Is there a producer credit on this film?',
                    'description': 'There are usually a lot of producers...',
                },
            ]
        },
        {
            "representative_2B": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "producer_credit"),
                        ("default", True),
                        ("prompt", "Is there a producer credit on this film?"),
                        ("description", "There are usually a lot of producers..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Allan Smithe"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ["Allan Smithe", "Ridley Scott", "Victor Fleming", "John Houston", "{{cookiecutter.producer_credit}}"]),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.producer_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )

    # Test changing variable's name field value, default field, prompt field,
    # and changing the type
    context_with_valid_extra_3 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_credit::producer_credits',
                    'default': 2,
                    'prompt': 'How many producers does this film have?',
                    'description': 'There are usually a lot of producers...',
                    'type': "int",
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "producer_credits"),
                        ("default", 2),
                        ("prompt", "How many producers does this film have?"),
                        ("description", "There are usually a lot of producers..."),
                        ("type", "int")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Allan Smithe"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ["Allan Smithe", "Ridley Scott", "Victor Fleming", "John Houston"]),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.producer_credits == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test changing choices field without changing the default, but default
    # does not change because the first position in choices matches default
    context_with_valid_extra_4 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_name',
                    'choices': ['Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston',
                                'John Ford', 'Billy Wilder'],
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Allan Smithe"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ['Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston', 'John Ford', 'Billy Wilder']),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test changing choices field and changing the default
    context_with_valid_extra_5 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_name',
                    'default': 'John Ford',
                    'choices': ['Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston',
                                'John Ford', 'Billy Wilder'],
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "John Ford"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ['John Ford', 'Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston', 'Billy Wilder']),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test changing the default, but not the choices field, yet seeing choices field re-ordered
    # to put default value in first location
    context_with_valid_extra_6 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_name',
                    'default': 'John Ford',
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "John Ford"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ['John Ford', 'Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston']),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test changing choices field without changing the default, but default
    # does get changee because the first position in choices field chagned
    context_with_valid_extra_7 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_name',
                    'choices': ['Billy Wilder', 'Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston',
                                'John Ford'],
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Billy Wilder"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ['Billy Wilder', 'Allan Smithe', 'Ridley Scott', 'Victor Fleming', 'John Houston', 'John Ford']),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    # Test changing the default value with a value that is not in choices,
    # we should see the choice first position get updated.
    context_with_valid_extra_8 = (
        {
            'context_file': 'tests/test-generate-context-v2/representative.json',
            'extra_context': [
                {
                    'name': 'director_name',
                    'default': 'Peter Sellers',
                }
            ]
        },
        {
            "representative": OrderedDict([
                ("name", "cc-representative"),
                ("cookiecutter_version", "2.0.0"),
                ("variables", [
                    OrderedDict([
                        ("name", "director_credit"),
                        ("default", True),
                        ("prompt", "Is there a director credit on this film?"),
                        ("description", "Directors take credit for most of their films, usually..."),
                        ("type", "boolean")
                    ]),
                    OrderedDict([
                        ("name", "director_name"),
                        ("default", "Peter Sellers"),
                        ("prompt", "What's the Director's full name?"),
                        ("prompt_user", True),
                        ("description", "The default director is not proud of their work, we hope you are."),
                        ("hide_input", False),
                        ("choices", ["Peter Sellers", "Allan Smithe", "Ridley Scott", "Victor Fleming", "John Houston"]),
                        ("validation", "^[a-z][A-Z]+$"),
                        ("validation_flags", ["verbose", "ascii"]),
                        ("skip_if", "{{cookiecutter.director_credit == False}}"),
                        ("type", "string")
                    ])
                ])
            ])
        }
    )
    yield context_with_valid_extra_0
    yield context_with_valid_extra_1
    yield context_with_valid_extra_2
    yield context_with_valid_extra_2_B
    yield context_with_valid_extra_3
    yield context_with_valid_extra_4
    yield context_with_valid_extra_5
    yield context_with_valid_extra_6
    yield context_with_valid_extra_7
    yield context_with_valid_extra_8