commitizen/tests/providers/test_npm_provider.py at 681e8aeb1d4b4ac048d7a2b0230b9b722490731b · commitizen-tools/commitizen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
from __future__ import annotations

from textwrap import dedent
from typing import TYPE_CHECKING

import pytest

from commitizen.providers import get_provider
from commitizen.providers.npm_provider import NpmProvider

if TYPE_CHECKING:
    from pathlib import Path

    from commitizen.config.base_config import BaseConfig

NPM_PACKAGE_JSON = """\
{
  "name": "whatever",
  "version": "0.1.0"
}
"""

NPM_PACKAGE_EXPECTED = """\
{
  "name": "whatever",
  "version": "42.1"
}
"""

NPM_LOCKFILE_JSON = """\
{
  "name": "whatever",
  "version": "0.1.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "whatever",
      "version": "0.1.0"
    },
    "someotherpackage": {
      "version": "0.1.0"
    }
  }
}
"""

NPM_LOCKFILE_EXPECTED = """\
{
  "name": "whatever",
  "version": "42.1",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "whatever",
      "version": "42.1"
    },
    "someotherpackage": {
      "version": "0.1.0"
    }
  }
}
"""

NPM_PACKAGE_JSON_LATIN1 = """\
{
  "name": "calf\u00e9-n\u00famero",
  "version": "0.1.0"
}
"""

NPM_LOCKFILE_JSON_LATIN1 = """\
{
  "name": "calf\u00e9-n\u00famero",
  "version": "0.1.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "calf\u00e9-n\u00famero",
      "version": "0.1.0"
    }
  }
}
"""


@pytest.mark.parametrize(
    ("pkg_shrinkwrap_content", "pkg_shrinkwrap_expected"),
    [(NPM_LOCKFILE_JSON, NPM_LOCKFILE_EXPECTED), (None, None)],
)
@pytest.mark.parametrize(
    ("pkg_lock_content", "pkg_lock_expected"),
    [(NPM_LOCKFILE_JSON, NPM_LOCKFILE_EXPECTED), (None, None)],
)
def test_npm_provider(
    config: BaseConfig,
    chdir: Path,
    pkg_lock_content: str,
    pkg_lock_expected: str,
    pkg_shrinkwrap_content: str,
    pkg_shrinkwrap_expected: str,
):
    pkg = chdir / NpmProvider.package_filename
    pkg.write_text(dedent(NPM_PACKAGE_JSON))
    if pkg_lock_content:
        pkg_lock = chdir / NpmProvider.lock_filename
        pkg_lock.write_text(dedent(pkg_lock_content))
    if pkg_shrinkwrap_content:
        pkg_shrinkwrap = chdir / NpmProvider.shrinkwrap_filename
        pkg_shrinkwrap.write_text(dedent(pkg_shrinkwrap_content))
    config.settings["version_provider"] = "npm"

    provider = get_provider(config)
    assert isinstance(provider, NpmProvider)
    assert provider.get_version() == "0.1.0"

    provider.set_version("42.1")
    assert pkg.read_text() == dedent(NPM_PACKAGE_EXPECTED)
    if pkg_lock_content:
        assert pkg_lock.read_text() == dedent(pkg_lock_expected)
    if pkg_shrinkwrap_content:
        assert pkg_shrinkwrap.read_text() == dedent(pkg_shrinkwrap_expected)


def test_npm_provider_respects_configured_encoding_for_all_files(
    config: BaseConfig,
    chdir: Path,
):
    """NpmProvider should use the configured encoding for all files it touches."""
    config.settings["encoding"] = "latin-1"
    config.settings["version_provider"] = "npm"

    pkg = chdir / NpmProvider.package_filename
    pkg_lock = chdir / NpmProvider.lock_filename
    pkg_shrinkwrap = chdir / NpmProvider.shrinkwrap_filename

    # Write initial contents using latin-1 encoding
    pkg.write_text(dedent(NPM_PACKAGE_JSON_LATIN1), encoding="latin-1")
    pkg_lock.write_text(dedent(NPM_LOCKFILE_JSON_LATIN1), encoding="latin-1")
    pkg_shrinkwrap.write_text(dedent(NPM_LOCKFILE_JSON_LATIN1), encoding="latin-1")

    provider = get_provider(config)
    assert isinstance(provider, NpmProvider)
    assert provider.get_version() == "0.1.0"

    provider.set_version("42.1")

    # Verify that the files can be read back using the configured encoding
    pkg_text = pkg.read_text(encoding="latin-1")
    pkg_lock_text = pkg_lock.read_text(encoding="latin-1")
    pkg_shrinkwrap_text = pkg_shrinkwrap.read_text(encoding="latin-1")

    # Version was updated everywhere
    assert '"version": "42.1"' in pkg_text
    assert '"version": "42.1"' in pkg_lock_text
    assert '"version": "42.1"' in pkg_shrinkwrap_text