Update GEMINI.md, add test cases for universal metadata, and configure rich dependency

This commit is contained in:
venus
2026-07-17 01:19:25 -05:00
parent 70e793c4a3
commit 1b53658a50
3 changed files with 228 additions and 29 deletions

View File

@@ -1,5 +1,8 @@
from pathlib import Path
import toml
import os
import stat
import sys
from click.testing import CliRunner
from ctf.utils import load_config, active_categories
from ctf.forensics import forensics_group, inspect
@@ -7,10 +10,43 @@ from ctf.forensics import forensics_group, inspect
# Define the persistent test environment path
TEST_ENV = Path("tests/env")
# =====================================================================
# 1. Test Strategy Summary
# =====================================================================
# Core scenarios tested:
#
# A. Happy Path:
# - Verifying metadata attributes (permissions, ownership, size,
# hard links, inode, device) map exactly to filesystem ground truth.
#
# B. Boundary Conditions:
# - Testing empty files (0 bytes) for correct apparent size and allocation.
# - Testing file permissions changes (e.g. read-only, executable) and
# making sure the parsed octal/symbolic codes match.
# - Testing multiple hard links (count > 1).
#
# C. Edge Cases & OS Portability:
# - Extended attributes (xattr) support, handling platforms where xattr
# is not present or supported on the active file system.
# - Graceful system identity fallbacks for UID/GID names when passwd/group
# databases are unavailable or running on non-Unix systems.
#
# D. Error Handling:
# - Accessing non-existent paths (CLI validation errors).
# =====================================================================
# =====================================================================
# 2. Mocking/Setup Requirements
# =====================================================================
# - Filesystem sandbox: Uses `tests/env/` to dynamically create files
# with specific mode bits, content, and links.
# - No external network/API mocking is required.
# - OS-specific conditional blocks handle platforms (e.g., Windows)
# where POSIX ownership resolution or xattr is not native.
# =====================================================================
def test_load_config_static():
"""
Verifies load_config using the persistent test file.
"""
"""Verifies load_config using the persistent test file."""
config_file = TEST_ENV / "config.toml"
test_data = {
"Competition": {"name": "PersistentComp"},
@@ -24,9 +60,7 @@ def test_load_config_static():
assert loaded_data["Competition"]["name"] == "PersistentComp"
def test_active_categories_static():
"""
Verifies active_categories using the pre-created 'comp1' folder.
"""
"""Verifies active_categories using the pre-created 'comp1' folder."""
comp_dir = TEST_ENV / "comp1"
comp_dir.mkdir(parents=True, exist_ok=True)
(comp_dir / "web").mkdir(exist_ok=True)
@@ -38,42 +72,162 @@ def test_active_categories_static():
assert "web" in cat_names
assert "pwn" in cat_names
# --- Direct Function Callback Tests ---
def test_inspect_callback_success():
# --- Task-Specific Universal Metadata Tests ---
def test_inspect_permissions():
"""
Verifies that calling the inspect command's callback directly returns
the correct FileMetadata dataclass with expected values.
Task 1: POSIX Permissions.
Verifies that the parsed octal and symbolic representation of permissions
matches Python's native os.stat mode decoding.
"""
test_file = TEST_ENV / "callback_test.txt"
test_file = TEST_ENV / "perm_test.bin"
with open(test_file, "wb") as f:
f.write(b"Hello World")
# Using inspect.callback to invoke the underlying undecorated function
f.write(b"data")
# Set permissions explicitly to 0o755 (rwxr-xr-x)
test_file.chmod(0o755)
meta = inspect.callback(str(test_file))
assert meta.filename == "callback_test.txt"
assert meta.size == 11
assert meta.magic == "48656C6C" # Hex for "Hell"
assert meta.extension == ".txt"
# Assert correct octal format
assert meta.permissions_octal == "0o755"
# Assert correct symbolic format (standard file type prefix '-')
assert meta.permissions_symbolic == "-rwxr-xr-x"
# Change permissions to 0o644 (rw-r--r--)
test_file.chmod(0o644)
meta_new = inspect.callback(str(test_file))
assert meta_new.permissions_octal == "0o644"
assert meta_new.permissions_symbolic == "-rw-r--r--"
def test_inspect_callback_empty_file():
def test_inspect_ownership():
"""
Tests the boundary case of an empty (0-byte) file.
Verifies that the parser handles it gracefully without raising exceptions.
Task 2: Ownership Identity.
Verifies that numeric UID/GID and resolved username/groupname match.
"""
test_file = TEST_ENV / "empty_test.txt"
test_file = TEST_ENV / "owner_test.bin"
with open(test_file, "wb") as f:
pass
f.write(b"data")
stat_info = test_file.stat()
meta = inspect.callback(str(test_file))
assert meta.filename == "empty_test.txt"
assert meta.size == 0
assert meta.magic == "" # Empty string as no bytes could be read
assert meta.extension == ".txt"
assert meta.owner_uid == stat_info.st_uid
assert meta.owner_gid == stat_info.st_gid
# On Unix, verify that user and group strings are resolved
if sys.platform != "win32":
import pwd
import grp
expected_user = pwd.getpwuid(stat_info.st_uid).pw_name
expected_group = grp.getgrgid(stat_info.st_gid).gr_name
assert meta.owner_username == expected_user
assert meta.owner_groupname == expected_group
else:
# Fallback for Windows
assert isinstance(meta.owner_username, str)
assert isinstance(meta.owner_groupname, str)
# --- CLI Integration Tests ---
def test_inspect_allocation():
"""
Task 3: Allocation Metrics.
Verifies apparent file size matches size_bytes, and allocated_size
corresponds to st_blocks * 512 bytes.
"""
test_file = TEST_ENV / "alloc_test.bin"
with open(test_file, "wb") as f:
f.write(b"A" * 1234)
stat_info = test_file.stat()
meta = inspect.callback(str(test_file))
assert meta.size == 1234
# st_blocks is Unix-specific. On other platforms, fallback to size on disk
if hasattr(stat_info, "st_blocks"):
expected_blocks_size = stat_info.st_blocks * 512
assert meta.allocated_size == expected_blocks_size
else:
assert meta.allocated_size >= 1234
def test_inspect_hard_links():
"""
Task 4: Hard Link Count.
Verifies that the hard link count changes when files are linked.
"""
test_file = TEST_ENV / "link_test.bin"
with open(test_file, "wb") as f:
f.write(b"link")
meta_single = inspect.callback(str(test_file))
assert meta_single.hard_links == 1
# Create a hard link
link_file = TEST_ENV / "link_test_hard.bin"
if link_file.exists():
link_file.unlink()
try:
os.link(str(test_file), str(link_file))
meta_linked = inspect.callback(str(test_file))
assert meta_linked.hard_links == 2
finally:
if link_file.exists():
link_file.unlink()
def test_inspect_inode_device():
"""
Task 5: Inode & Device Identifiers.
Verifies that the unique Inode number and Device ID match os.stat results.
"""
test_file = TEST_ENV / "inode_test.bin"
with open(test_file, "wb") as f:
f.write(b"data")
stat_info = test_file.stat()
meta = inspect.callback(str(test_file))
assert meta.inode == stat_info.st_ino
assert meta.device == stat_info.st_dev
def test_inspect_extended_attributes():
"""
Task 6: Extended Attributes (xattr).
Checks that user-defined extended attributes can be retrieved if supported
by the platform and filesystem.
"""
test_file = TEST_ENV / "xattr_test.bin"
with open(test_file, "wb") as f:
f.write(b"data")
# Attempt to set an extended attribute (Linux/macOS specific)
has_xattr_support = False
if sys.platform in ("linux", "darwin"):
try:
import xattr
# Use user namespace for custom attribute
os.setxattr(str(test_file), "user.ctf_flag", b"FLAG{filesystem_metadata_ftw}")
has_xattr_support = True
except (ImportError, OSError, AttributeError):
pass
meta = inspect.callback(str(test_file))
if has_xattr_support:
assert "user.ctf_flag" in meta.extended_attributes
assert meta.extended_attributes["user.ctf_flag"] == "FLAG{filesystem_metadata_ftw}"
else:
# Should gracefully return an empty dict if not supported or none defined
assert isinstance(meta.extended_attributes, dict)
# --- CLI Validation Tests ---
def test_forensics_inspect_cli_success():
"""
@@ -89,7 +243,7 @@ def test_forensics_inspect_cli_success():
assert result.exit_code == 0
assert "Metadata: test_file.png" in result.output
assert "Size" in result.output
assert "89504E47" in result.output # Hex representation of PNG signature
assert "89504E47" in result.output
def test_forensics_inspect_cli_missing_file():
"""