Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: populate context from config #452

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions beet/toolchain/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,26 @@ def build(self) -> Iterator[Context]:
whitelist=self.config.whitelist,
)

# populate ctx.pack with config info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theses changes are good

if self.config.data_pack.pack_format:
ctx.data.pack_format = self.config.data_pack.pack_format
if self.config.data_pack.name:
ctx.data.name = self.config.data_pack.name
if self.config.data_pack.description:
ctx.data.description = self.config.data_pack.description
if self.config.data_pack.supported_formats:
ctx.data.supported_formats = self.config.data_pack.supported_formats
if self.config.resource_pack.pack_format:
ctx.assets.pack_format = self.config.resource_pack.pack_format
if self.config.resource_pack.name:
ctx.assets.name = self.config.resource_pack.name
if self.config.resource_pack.description:
ctx.assets.description = self.config.resource_pack.description
if self.config.resource_pack.supported_formats:
ctx.assets.supported_formats = (
self.config.resource_pack.supported_formats
)

plugins: List[PluginSpec] = [self.bootstrap]
plugins.extend(
(
Expand Down
18 changes: 18 additions & 0 deletions tests/ctx_config_examples/mcmeta/beet.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"data_pack": {
"name": "My Data Pack",
"description": "a data pack",
"pack_format": 6,
"supported_formats": [0,6]
},
"resource_pack": {
"name": "My Resource Pack",
"description": "a resource pack",
"pack_format": 10,
"supported_formats": {
"min_inclusive": 10,
"max_inclusive": 20
}
},
"pipeline": ["mcmeta"]
}
9 changes: 9 additions & 0 deletions tests/ctx_config_examples/mcmeta/mcmeta.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from beet import Context


def beet_default(ctx: Context):
all = [
f"{ctx.data.mcmeta.data}",
f"{ctx.assets.mcmeta.data}",
]
ctx.meta["pytest"] = "\n".join(all) + "\n"
18 changes: 18 additions & 0 deletions tests/ctx_config_examples/pack_info/beet.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"data_pack": {
"name": "My Data Pack",
"description": "a data pack",
"pack_format": 6,
"supported_formats": [0,6]
},
"resource_pack": {
"name": "My Resource Pack",
"description": "a resource pack",
"pack_format": 10,
"supported_formats": {
"min_inclusive": 10,
"max_inclusive": 20
}
},
"pipeline": ["pack_info"]
}
15 changes: 15 additions & 0 deletions tests/ctx_config_examples/pack_info/pack_info.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
from beet import Context


def beet_default(ctx: Context):
all = [
f"{ctx.data.name}",
f"{ctx.data.description}",
f"{ctx.data.pack_format}",
f"{ctx.data.supported_formats}",
f"{ctx.assets.name}",
f"{ctx.assets.description}",
f"{ctx.assets.pack_format}",
f"{ctx.assets.supported_formats}",
]
ctx.meta["pytest"] = "\n".join(all) + "\n"
9 changes: 9 additions & 0 deletions tests/ctx_config_examples/project_info/beet.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"author": "somebody",
"version": "1.2.3",
"name": "BEET",
"id": "beet",
"description": "a beet project",
"minecraft": "1.19",
"pipeline": ["project_info"]
}
13 changes: 13 additions & 0 deletions tests/ctx_config_examples/project_info/project_info.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from beet import Context


def beet_default(ctx: Context):
all = [
f"{ctx.minecraft_version}",
f"{ctx.project_author}",
f"{ctx.project_description}",
f"{ctx.project_id}",
f"{ctx.project_name}",
f"{ctx.project_version}",
]
ctx.meta["pytest"] = "\n".join(all) + "\n"
2 changes: 2 additions & 0 deletions tests/snapshots/ctx_config__examples_mcmeta__0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{'pack': {'pack_format': 6, 'description': 'a data pack', 'supported_formats': [0, 6]}}
{'pack': {'pack_format': 10, 'description': 'a resource pack', 'supported_formats': {'min_inclusive': 10, 'max_inclusive': 20}}}
8 changes: 8 additions & 0 deletions tests/snapshots/ctx_config__examples_pack_info__0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
My Data Pack
a data pack
6
[0, 6]
My Resource Pack
a resource pack
10
{'min_inclusive': 10, 'max_inclusive': 20}
6 changes: 6 additions & 0 deletions tests/snapshots/ctx_config__examples_project_info__0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
1.19
somebody
a beet project
beet
BEET
1.2.3
12 changes: 12 additions & 0 deletions tests/test_ctx_config.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import os

import pytest
from pytest_insta import SnapshotFixture

from beet import run_beet


@pytest.mark.parametrize("directory", os.listdir("tests/ctx_config_examples"))
def test_examples(snapshot: SnapshotFixture, directory: str):
with run_beet(directory=f"tests/ctx_config_examples/{directory}") as ctx:
assert snapshot() == f'{ctx.meta["pytest"]}'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here instead of creating a snapshot from f'{ctx.meta["pytest"]}', it's maybe better to it like this :

with run_beet(directory=f"tests/ctx_config_examples/{directory}") as ctx:
    assert snapshot() == {
        "minecraft_version": ctx.minecraft_version,
        "project_author": ctx.project_author,
        # (... with all other parts of the config transferred to the ctx variable )
        }

This would eliminate the need of per directory plugin, and the need of a the new subfolder ctx_config_examples in favor of config_examples (transferring all examples to the old folder).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bug (#451) only occurs when trying to read the values in a plugin, so checking it in the test function will give a different result. Basically, the problem is that plugins can't access the info because it's populated only when building the pack (i.e. after running the plugins). Since run_beet populates ctx as if it was built to completion, the bug isn't caught by checking ctx in the test function.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh i see, i don't like the ctx.meta["pytest"] access, but it's the only way i can think of accessing plugin phase value.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that was the main reason I wanted a review; the ctx.meta["pytest"] feels really janky, but I couldn't find another way to check those values.

Loading