Skip to content

Commit a7c85ef

Browse files
syrkissyrkis
committed
Fix CMake compatibility for modern versions (3.28+)
- Updated CMake minimum versions in submodules to 3.10 - Added Python build artifacts to .gitignore - Added BUILD_FIXES.md documenting the changes - Added test_pybaba.py for verification - Package now builds with modern CMake and installs via pip/uv
1 parent 0c49b2b commit a7c85ef

File tree

4 files changed

+304
-3
lines changed

4 files changed

+304
-3
lines changed

‎.gitignore‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ build
1515

1616
# Visual Studio Code files
1717
/.vscode
18-
*.code-workspace
18+
*.code-workspace
1919

2020
# OSX files
2121
.DS_Store
@@ -31,6 +31,9 @@ cmake-build-debug
3131
# Python files
3232
*.pyc
3333
/.pytest_cache
34+
*.so
35+
*.egg-info/
36+
*.egg-info
3437

3538
# RL files
36-
events.out.tfevents.*
39+
events.out.tfevents.*

‎BUILD_FIXES.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# pyBaba Build Fixes
2+
3+
This document describes the fixes applied to make pyBaba buildable with modern CMake versions and installable via pip/uv.
4+
5+
## Problem
6+
7+
The original repository had CMake minimum version requirements that are incompatible with modern CMake (3.28+):
8+
- Various CMakeLists.txt files required CMake 3.0 or 3.4
9+
- Modern CMake has removed compatibility with versions < 3.5
10+
11+
## Fixes Applied
12+
13+
### 1. Updated CMake Minimum Versions
14+
15+
The following files were modified to require CMake 3.10:
16+
17+
- `Libraries/doctest/CMakeLists.txt`
18+
- `Libraries/pybind11/CMakeLists.txt`
19+
- `Libraries/pybind11/tests/CMakeLists.txt`
20+
- `Libraries/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt`
21+
- `Libraries/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt`
22+
- `Libraries/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt`
23+
- `Libraries/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt`
24+
- `Libraries/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt`
25+
- `Libraries/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt`
26+
27+
Changed from:
28+
```cmake
29+
cmake_minimum_required(VERSION 3.0) # or 3.4
30+
```
31+
32+
To:
33+
```cmake
34+
cmake_minimum_required(VERSION 3.10)
35+
```
36+
37+
### 2. Updated .gitignore
38+
39+
Added Python build artifacts to .gitignore:
40+
```
41+
*.so
42+
*.egg-info/
43+
*.egg-info
44+
```
45+
46+
## Building pyBaba
47+
48+
### Prerequisites
49+
- CMake 3.10 or higher
50+
- C++ compiler (Clang/GCC)
51+
- Python 3.11+
52+
- uv (for Python package management)
53+
54+
### Build Steps
55+
56+
1. **Clone with submodules:**
57+
```bash
58+
git clone https://github.com/YOUR_USERNAME/baba-is-auto.git --recursive
59+
cd baba-is-auto
60+
```
61+
62+
2. **Build the C++ library:**
63+
```bash
64+
mkdir build
65+
cd build
66+
cmake ..
67+
make pyBaba -j8
68+
cd ..
69+
```
70+
71+
3. **Install with uv:**
72+
```bash
73+
uv pip install -e .
74+
```
75+
76+
## Testing
77+
78+
Run the test script to verify installation:
79+
```bash
80+
uv run python test_pybaba.py
81+
```
82+
83+
Expected output:
84+
```
85+
✓ pyBaba imported successfully!
86+
✓ Found object types: BABA, WALL, ROCK, FLAG, WATER...
87+
✓ Game created successfully!
88+
✓ RandomAgent created successfully!
89+
✓ RuleManager class found
90+
```
91+
92+
## Using in Your Project
93+
94+
Add to your `pyproject.toml`:
95+
```toml
96+
dependencies = [
97+
"pybaba @ git+https://github.com/YOUR_USERNAME/baba-is-auto.git"
98+
]
99+
```
100+
101+
Or install directly:
102+
```bash
103+
uv pip install git+https://github.com/YOUR_USERNAME/baba-is-auto.git
104+
```
105+
106+
## Troubleshooting
107+
108+
### CMake Version Errors
109+
If you still get CMake version errors, you can use:
110+
```bash
111+
cmake .. -DCMAKE_POLICY_VERSION_MINIMUM=3.5
112+
```
113+
114+
### Python Module Not Found
115+
Ensure you're using the same Python environment where you installed pyBaba:
116+
```bash
117+
uv run python -c "import pyBaba"
118+
```
119+
120+
### Build Errors
121+
Clean the build directory and try again:
122+
```bash
123+
rm -rf build
124+
mkdir build
125+
cd build
126+
cmake ..
127+
make pyBaba
128+
```
129+
130+
## Notes
131+
132+
- The main `CMakeLists.txt` already required version 3.8.2, which is compatible
133+
- The fixes were primarily needed for the submodules (doctest and pybind11)
134+
- These changes allow the package to be built with CMake 3.28+ and installed via pip/uv

‎CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ add_subdirectory(Libraries/pybind11)
5555
if (BUILD_FROM_PIP)
5656
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${DEFAULT_CMAKE_LIBRARY_OUTPUT_DIRECTORY})
5757
endif()
58-
add_subdirectory(Extensions/BabaPython)
58+
add_subdirectory(Extensions/BabaPython)

‎test_pybaba.py‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
#!/usr/bin/env python3
2+
"""Test script to verify pyBaba is working correctly."""
3+
4+
import os
5+
import sys
6+
7+
try:
8+
import pyBaba
9+
10+
print("✓ pyBaba imported successfully!")
11+
except ImportError as e:
12+
print(f"✗ Failed to import pyBaba: {e}")
13+
sys.exit(1)
14+
15+
16+
def test_enums():
17+
"""Test that enums are accessible."""
18+
print("\n=== Testing Enums ===")
19+
20+
# Test some object types
21+
objects = ["BABA", "WALL", "ROCK", "FLAG", "WATER", "KEY", "DOOR"]
22+
available = [obj for obj in objects if hasattr(pyBaba, obj)]
23+
print(f"✓ Found {len(available)}/{len(objects)} object types: {available[:5]}...")
24+
25+
# Test directions
26+
directions = [
27+
"DIRECTION_NONE",
28+
"DIRECTION_UP",
29+
"DIRECTION_DOWN",
30+
"DIRECTION_LEFT",
31+
"DIRECTION_RIGHT",
32+
]
33+
available_dirs = [d for d in directions if hasattr(pyBaba, d)]
34+
print(
35+
f"✓ Found {len(available_dirs)}/{len(directions)} directions: {available_dirs}"
36+
)
37+
38+
# Test properties
39+
properties = ["YOU", "WIN", "STOP", "PUSH", "SINK", "DEFEAT", "HOT", "MELT", "MOVE"]
40+
available_props = [p for p in properties if hasattr(pyBaba, p)]
41+
print(
42+
f"✓ Found {len(available_props)}/{len(properties)} properties: {available_props[:5]}..."
43+
)
44+
45+
46+
def test_game_creation():
47+
"""Test game creation and basic operations."""
48+
print("\n=== Testing Game Creation ===")
49+
50+
# Find a map file
51+
map_path = "Resources/Maps/simple_map.txt"
52+
if not os.path.exists(map_path):
53+
# Try alternative paths
54+
for alternative in ["simple_map.txt", "baba_is_you.txt"]:
55+
alt_path = os.path.join("Resources", "Maps", alternative)
56+
if os.path.exists(alt_path):
57+
map_path = alt_path
58+
break
59+
60+
if not os.path.exists(map_path):
61+
print(f"✗ Could not find map file at {map_path}")
62+
return False
63+
64+
print(f"✓ Found map file: {map_path}")
65+
66+
try:
67+
# Create game
68+
game = pyBaba.Game(map_path)
69+
print("✓ Game created successfully!")
70+
71+
# Test game methods
72+
if hasattr(game, "GetMap"):
73+
map_obj = game.GetMap()
74+
print(f"✓ Got map object: {map_obj}")
75+
76+
if hasattr(map_obj, "GetWidth") and hasattr(map_obj, "GetHeight"):
77+
width = map_obj.GetWidth()
78+
height = map_obj.GetHeight()
79+
print(f"✓ Map dimensions: {width}x{height}")
80+
81+
# Test game state
82+
if hasattr(game, "GetPlayState"):
83+
state = game.GetPlayState()
84+
print(f"✓ Game play state: {state}")
85+
86+
# Test movement
87+
if hasattr(game, "MovePlayer"):
88+
print("✓ MovePlayer method available")
89+
# Try a move (might not do anything if no player)
90+
if hasattr(pyBaba, "DIRECTION_RIGHT"):
91+
result = game.MovePlayer(pyBaba.DIRECTION_RIGHT)
92+
print(f"✓ Attempted move right: {result}")
93+
94+
return True
95+
96+
except Exception as e:
97+
print(f"✗ Error creating/using game: {e}")
98+
return False
99+
100+
101+
def test_agents():
102+
"""Test agent functionality."""
103+
print("\n=== Testing Agents ===")
104+
105+
if hasattr(pyBaba, "RandomAgent"):
106+
try:
107+
agent = pyBaba.RandomAgent()
108+
print("✓ RandomAgent created successfully!")
109+
110+
# Test agent methods
111+
if hasattr(agent, "GetAction"):
112+
print("✓ GetAction method available")
113+
114+
return True
115+
except Exception as e:
116+
print(f"✗ Error creating RandomAgent: {e}")
117+
return False
118+
else:
119+
print("✗ RandomAgent not found in pyBaba")
120+
return False
121+
122+
123+
def test_rule_manager():
124+
"""Test RuleManager functionality."""
125+
print("\n=== Testing RuleManager ===")
126+
127+
if hasattr(pyBaba, "RuleManager"):
128+
try:
129+
# RuleManager might need specific initialization
130+
print("✓ RuleManager class found")
131+
return True
132+
except Exception as e:
133+
print(f"✗ Error with RuleManager: {e}")
134+
return False
135+
else:
136+
print("✗ RuleManager not found in pyBaba")
137+
return False
138+
139+
140+
def main():
141+
"""Run all tests."""
142+
print("=" * 50)
143+
print("pyBaba Module Test Suite")
144+
print("=" * 50)
145+
146+
# Print module info
147+
print(
148+
f"\nModule location: {pyBaba.__file__ if hasattr(pyBaba, '__file__') else 'Built-in'}"
149+
)
150+
print(f"Available attributes: {len(dir(pyBaba))}")
151+
152+
# Run tests
153+
test_enums()
154+
test_game_creation()
155+
test_agents()
156+
test_rule_manager()
157+
158+
print("\n" + "=" * 50)
159+
print("Test suite completed!")
160+
print("=" * 50)
161+
162+
163+
if __name__ == "__main__":
164+
main()

0 commit comments

Comments
 (0)