Merge pull request #18 from DogFortune/issue/16-create-test

テストの追加

Author: DogFortune

.github/workflows/dataset-update.yml

@@ -9,10 +9,34 @@ on:
   workflow_dispatch:
 
 permissions:
+  checks: write
   contents: write
   pull-requests: write
 
 jobs:
+  test:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+          cache: "pipenv"
+      - name: Install pipenv
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pipenv
+      - name: Install packages
+        run: pipenv sync --dev
+      - name: Run pytest
+        run: pipenv run pytest -q --junit-xml pytest.xml
+        continue-on-error: true
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v5
+        if: success() || failure()
+        with:
+          report_paths: "pytest.xml"
   update-dataset:
     runs-on: ubuntu-24.04
     timeout-minutes: 5
@@ -31,7 +55,7 @@ jobs:
         with:
           python-version: "3.14"
       - name: Update Dataset
-        run: python scripts/main.py
+        run: python scripts/app/main.py
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v8
         with:

Pipfile

@@ -6,6 +6,8 @@ name = "pypi"
 [packages]
 
 [dev-packages]
+pytest = "*"
+black = "*"
 
 [requires]
 python_version = "3.14"

Pipfile.lock

@@ -6,3 +6,6 @@ exclude = '''
   | \.venv
 )/
 '''
+[tool.pytest.ini_options]
+pythonpath = "scripts"
+testpaths = ["tests"]

pyproject.toml

@@ -3,14 +3,16 @@
 from pathlib import Path
 
 
-def __load_json(path: str):
+def load_json(path: str):
     with open(path) as f:
         raw_json = json.load(f)
 
     return raw_json
 
 
-def create_file(file_data: dict, is_ext: bool, verbose: bool):
+def create_file(
+    file_data: dict, is_ext: bool, verbose: bool, current: Path = Path("files")
+):
     """ファイルを作成します
 
     :param file_data: テーマから抽出したファイル情報
@@ -20,12 +22,11 @@ def create_file(file_data: dict, is_ext: bool, verbose: bool):
     :param verbose: 詳細表示か否か
     :type verbose: bool
     """
-    current = Path("files")
     if not current.is_dir():
         current.mkdir()
-    for key in file_data.keys():
+    for key, value in file_data.items():
         file_path = (
-            current.joinpath(f"DummyName.{key}") if is_ext else current.joinpath(key)
+            current.joinpath(f"{value}.{key}") if is_ext else current.joinpath(key)
         )
         if file_path.is_file():
             if verbose:
@@ -37,15 +38,14 @@ def create_file(file_data: dict, is_ext: bool, verbose: bool):
             print(f"create: {str(file_path)}")
 
 
-def create_folder(folder_data: dict, verbose: bool):
+def create_folder(folder_data: dict, verbose: bool, current: Path = Path("folders")):
     """フォルダを作成します。フォルダだけだとgit管理に含まれないのでからのファイルをフォルダ内に作っておきます。
 
     :param folder_info_json: _description_
     :type folder_info_json: dict
     :param verbose: 詳細表示か否か
     :type verbose: bool
     """
-    current = Path("folders")
     if not current.is_dir():
         current.mkdir()
     for folder_name in folder_data.keys():
@@ -73,13 +73,13 @@ def main(args=None):
 
     verbose = args.verbose
 
-    file_data = __load_json("./manifests/files.json")
+    file_data = load_json("./manifests/files.json")
     create_file(file_data, False, verbose)
 
-    ext_data = __load_json("./manifests/extensions.json")
+    ext_data = load_json("./manifests/extensions.json")
     create_file(ext_data, True, verbose)
 
-    folder_data = __load_json("./manifests/folders.json")
+    folder_data = load_json("./manifests/folders.json")
     create_folder(folder_data, verbose)
 
 

scripts/main.py scripts/app/main.pyscripts/main.py renamed to scripts/app/main.py

@@ -0,0 +1,51 @@
+from app import main
+from tempfile import TemporaryDirectory
+from pathlib import Path
+import pytest
+
+
+@pytest.mark.parametrize(
+    ["data", "is_ext", "expected_file_name"],
+    [
+        pytest.param({".pug-lintrc": "pug"}, False, ".pug-lintrc"),
+        pytest.param({"png": "image"}, True, "image.png"),
+        pytest.param({"key": "value"}, True, "value.key"),
+    ],
+)
+def test_create_file(data, is_ext, expected_file_name):
+    """渡したデータから、想定している名前のファイルが生成されている事
+    file.json -> ファイル名は{key}になる事
+    extensions.json -> ファイル名は{value}.{key}になる事
+
+    :param data: _description_
+    :type data: _type_
+    :param is_ext: _description_
+    :type is_ext: bool
+    :param expected_file_name: _description_
+    :type expected_file_name: _type_
+    """
+    with TemporaryDirectory() as dir:
+        current = Path(dir)
+        main.create_file(data, is_ext, False, current)
+
+        result_file = list(current.iterdir())
+
+        assert len(result_file) == 1
+        assert result_file[0].name == expected_file_name
+
+
+@pytest.mark.parametrize(
+    ["data", "expected_folder_name"],
+    [
+        pytest.param({"rust": "folder-rust"}, "rust"),
+    ],
+)
+def test_create_folder(data, expected_folder_name):
+    with TemporaryDirectory() as dir:
+        current = Path(dir)
+        main.create_folder(data, False, current)
+
+        result_folder = list(current.iterdir())
+        print(result_folder)
+        assert len(result_folder) == 1
+        assert result_folder[0].name == expected_folder_name