anki-connect/tests/test_models.py

from conftest import ac
from plugin import anki_version


def test_modelNames(setup):
    result = ac.modelNames()
    assert "test_model" in result


def test_modelNamesAndIds(setup):
    result = ac.modelNamesAndIds()
    assert isinstance(result["test_model"], int)


def test_modelFieldNames(setup):
    result = ac.modelFieldNames(modelName="test_model")
    assert result == ["field1", "field2"]


def test_modelFieldDescriptions(setup):
    result = ac.modelFieldDescriptions(modelName="test_model")
    assert result == ["", ""]


def test_modelFieldFonts(setup):
    result = ac.modelFieldFonts(modelName="test_model")
    assert result == {
        "field1": {
            "font": "Arial",
            "size": 20,
        },
        "field2": {
            "font": "Arial",
            "size": 20,
        },
    }


def test_modelFieldsOnTemplates(setup):
    result = ac.modelFieldsOnTemplates(modelName="test_model")
    assert result == {
        "Card 1": [["field1"], ["field2"]],
        "Card 2": [["field2"], ["field1"]],
    }


class TestCreateModel:
    createModel_kwargs = {
        "modelName": "test_model_foo",
        "inOrderFields": ["field1", "field2"],
        "cardTemplates": [{"Front": "{{field1}}", "Back": "{{field2}}"}],
    }

    def test_createModel_without_css(self, session_with_profile_loaded):
        ac.createModel(**self.createModel_kwargs)

    def test_createModel_with_css(self, session_with_profile_loaded):
        ac.createModel(**self.createModel_kwargs, css="* {}")


class TestStyling:
    def test_modelStyling(self, setup):
        result = ac.modelStyling(modelName="test_model")
        assert result == {"css": "* {}"}

    def test_updateModelStyling(self, setup):
        ac.updateModelStyling(model={
            "name": "test_model",
            "css": "* {color: red;}"
        })

        assert ac.modelStyling(modelName="test_model") == {
            "css": "* {color: red;}"
        }


class TestModelTemplates:
    def test_modelTemplates(self, setup):
        result = ac.modelTemplates(modelName="test_model")
        assert result == {
            "Card 1": {"Front": "{{field1}}", "Back": "{{field2}}"},
            "Card 2": {"Front": "{{field2}}", "Back": "{{field1}}"}
        }

    def test_updateModelTemplates(self, setup):
        ac.updateModelTemplates(model={
            "name": "test_model",
            "templates": {"Card 1": {"Front": "{{field1}}", "Back": "foo"}}
        })

        assert ac.modelTemplates(modelName="test_model") == {
            "Card 1": {"Front": "{{field1}}", "Back": "foo"},
            "Card 2": {"Front": "{{field2}}", "Back": "{{field1}}"}
        }


def test_findAndReplaceInModels(setup):
    ac.findAndReplaceInModels(
        modelName="test_model",
        findText="}}",
        replaceText="}}!",
        front=True,
        back=False,
        css=False,
    )

    ac.findAndReplaceInModels(
        modelName="test_model",
        findText="}}",
        replaceText="}}?",
        front=True,
        back=True,
        css=False,
    )

    ac.findAndReplaceInModels(
        modelName="test_model",
        findText="}",
        replaceText="color: blue;}",
        front=False,
        back=False,
        css=True,
    )

    assert ac.modelTemplates(modelName="test_model") == {
        "Card 1": {"Front": "{{field1}}?!", "Back": "{{field2}}?"},
        "Card 2": {"Front": "{{field2}}?!", "Back": "{{field1}}?"}
    }

    assert ac.modelStyling(modelName="test_model") == {
        "css": "* {color: blue;}"
    }


class TestModelTemplates:
    def test_modelTemplateRename(self, setup):
        ac.modelTemplateRename(
            modelName="test_model",
            oldTemplateName="Card 1",
            newTemplateName="Card 1 Renamed",
        )

        result = ac.modelTemplates(modelName="test_model")
        assert result == {
            "Card 1 Renamed": {"Front": "{{field1}}", "Back": "{{field2}}"},
            "Card 2": {"Front": "{{field2}}", "Back": "{{field1}}"}
        }

    def test_modelTemplateReposition(self, setup):
        # There currently isn't a way to test for order, so this is just a
        # smoke test for now
        ac.modelTemplateReposition(
            modelName="test_model",
            templateName="Card 1",
            index=1,
        )

    def test_modelTemplateAdd(self, setup):
        ac.modelTemplateAdd(
            modelName="test_model",
            template={
                "Name": "Card 3",
                "Front": "{{field1}} Card 3",
                "Back": "{{field2}}",
            }
        )

        result = ac.modelTemplates(modelName="test_model")
        assert result == {
            "Card 1": {"Front": "{{field1}}", "Back": "{{field2}}"},
            "Card 2": {"Front": "{{field2}}", "Back": "{{field1}}"},
            "Card 3": {"Front": "{{field1}} Card 3", "Back": "{{field2}}"},
        }

    def test_modelTemplateRemove(self, setup):
        ac.modelTemplateRemove(
            modelName="test_model",
            templateName="Card 2"
        )

        result = ac.modelTemplates(modelName="test_model")
        assert result == {
            "Card 1": {"Front": "{{field1}}", "Back": "{{field2}}"},
        }


class TestModelFieldNames:
    def test_modelFieldRename(self, setup):
        ac.modelFieldRename(
            modelName="test_model",
            oldFieldName="field1",
            newFieldName="foo",
        )

        result = ac.modelFieldNames(modelName="test_model")
        assert result == ["foo", "field2"]

    def test_modelFieldReposition(self, setup):
        ac.modelFieldReposition(
            modelName="test_model",
            fieldName="field1",
            index=2,
        )

        result = ac.modelFieldNames(modelName="test_model")
        assert result == ["field2", "field1"]

    def test_modelFieldAdd(self, setup):
        ac.modelFieldAdd(
            modelName="test_model",
            fieldName="Foo",
        )

        result = ac.modelFieldNames(modelName="test_model")
        assert result == ["field1", "field2", "Foo"]

    def test_modelFieldAdd_with_index(self, setup):
        ac.modelFieldAdd(
            modelName="test_model",
            fieldName="Foo",
            index=1,
        )

        result = ac.modelFieldNames(modelName="test_model")
        assert result == ["field1", "Foo", "field2"]

    def test_modelFieldRemove(self, setup):
        # makes sure that the front template always has a field,
        # and makes sure that the front template of the cards are not the same
        ac.updateModelTemplates(model={
            "name": "test_model",
            "templates": {"Card 1": {"Front": "{{field2}} {{field2}}", "Back": "foo"}}
        })

        ac.modelFieldRemove(
            modelName="test_model",
            fieldName="field1",
        )

        result = ac.modelFieldNames(modelName="test_model")
        assert result == ["field2"]

    def test_modelFieldSetFont(self, setup):
        ac.modelFieldSetFont(
            modelName="test_model",
            fieldName="field1",
            font="Courier",
        )

        result = ac.modelFieldFonts(modelName="test_model")
        assert result == {
            "field1": {
                "font": "Courier",
                "size": 20,
            },
            "field2": {
                "font": "Arial",
                "size": 20,
            },
        }

    def test_modelFieldSetFontSize(self, setup):
        ac.modelFieldSetFontSize(
            modelName="test_model",
            fieldName="field2",
            fontSize=16,
        )

        result = ac.modelFieldFonts(modelName="test_model")
        assert result == {
            "field1": {
                "font": "Arial",
                "size": 20,
            },
            "field2": {
                "font": "Arial",
                "size": 16,
            },
        }

    def test_modelFieldSetDescription(self, setup):
        set_desc = ac.modelFieldSetDescription(
            modelName="test_model",
            fieldName="field1",
            description="test description",
        )

        result = ac.modelFieldDescriptions(modelName="test_model")

        if anki_version < (2, 1, 50):
            assert not set_desc
            assert result == ["", ""]
        else:
            assert set_desc
            assert result == ["test description", ""]