Skip to content

Dev #11

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.

Sign up for GitHub

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

Merged
marwaneltoukhy merged 4 commits into from
Mar 17, 2026
Merged

Dev #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a76eed
Refactor precheck command and improve Docker handling
marwaneltoukhy Mar 17, 2026
598bde7
Refactor precheck command to use pip installation and improve argumen…
marwaneltoukhy Mar 17, 2026
d4c8389
Enhance precheck setup and Docker handling
marwaneltoukhy Mar 17, 2026
5af8ca1
Bump version to 2.2.0 for PyPI release
marwaneltoukhy Mar 17, 2026
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
207 changes: 77 additions & 130 deletions chipfoundry_cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2762,56 +2762,33 @@ def maybe_abort_no_space(err, step_label):
if install_precheck:
step_num = 8 if not only_mode else ""
console.print(f"\n[bold]Step {step_num}:[/bold] Installing precheck...")
precheck_dir = Path.home() / 'mpw_precheck'

# Check if already installed
is_installed = precheck_dir.exists() and (precheck_dir / '.git').exists()

if is_installed and not overwrite:
console.print("[green]✓[/green] Precheck already installed")
elif dry_run:
if is_installed:
console.print("[dim]Would reinstall mpw_precheck [--overwrite][/dim]")
else:
console.print("[dim]Would install mpw_precheck[/dim]")
if dry_run:
console.print("[dim]Would install/upgrade cf-precheck Python package[/dim]")
else:
try:
if precheck_dir.exists() and overwrite:
console.print(f"[cyan]Removing existing {precheck_dir}...[/cyan]")
shutil.rmtree(precheck_dir)

if not precheck_dir.exists():
console.print("[cyan]Cloning mpw_precheck...[/cyan]")
subprocess.run(
['git', 'clone', '--depth=1', 'https://github.com/chipfoundry/mpw_precheck.git', str(precheck_dir)],
check=True,
capture_output=True,
text=True
)
console.print("[green]✓[/green] Precheck cloned successfully")

if shutil.which('docker') is None:
had_errors = True
console.print("[red]✗[/red] Docker not found. Install Docker Desktop to pull the precheck image.")
console.print("[dim]Precheck repo cloned, but Docker image was not pulled.[/dim]")
else:
console.print("[cyan]Pulling precheck Docker image...[/cyan]")
subprocess.run(
['docker', 'pull', 'chipfoundry/mpw_precheck:latest'],
check=True,
capture_output=True
console.print("[cyan]Installing cf-precheck...[/cyan]")
subprocess.run(
[sys.executable, '-m', 'pip', 'install', '--upgrade', '-q', 'cf-precheck'],
check=True,
capture_output=True,
text=True,
)
try:
result = subprocess.run(
[sys.executable, '-c', 'from cf_precheck import __version__; print(__version__)'],
capture_output=True, text=True,
)
console.print("[green]✓[/green] Precheck Docker image ready")

version = result.stdout.strip()
console.print(f"[green]✓[/green] cf-precheck v{version} installed")
except Exception:
console.print("[green]✓[/green] cf-precheck installed")
except subprocess.CalledProcessError as e:
maybe_abort_no_space(e, "Precheck install")
had_errors = True
console.print(f"[red]✗[/red] Failed to install precheck: {e}")
console.print(f"[red]✗[/red] Failed to install cf-precheck: {e}")
if e.stderr:
console.print(f"[dim]{e.stderr}[/dim]")
except OSError as e:
had_errors = True
console.print(f"[red]✗[/red] Failed to install precheck: {e}")

# Summary
console.print("\n" + "="*60)
Expand Down Expand Up @@ -3216,21 +3193,22 @@ def repo_update(project_root, repo_owner, repo_name, branch, dry_run):

@main.command('precheck')
@click.option('--project-root', type=click.Path(exists=True, file_okay=False), help='Path to the project directory (defaults to current directory)')
@click.option('--disable-lvs', is_flag=True, help='Disable LVS check and run specific checks only')
@click.option('--skip-checks', multiple=True, help='Checks to skip (can be specified multiple times)')
@click.option('--magic-drc', is_flag=True, help='Include Magic DRC check (optional, off by default)')
@click.option('--checks', multiple=True, help='Specific checks to run (can be specified multiple times)')
@click.option('--dry-run', is_flag=True, help='Show the command without running')
def precheck(project_root, disable_lvs, checks, dry_run):
"""Run mpw_precheck validation on the project.
def precheck(project_root, skip_checks, magic_drc, checks, dry_run):
"""Run precheck validation on the project.

This runs the MPW (Multi-Project Wafer) precheck tool to validate
your design before submission.
This runs the cf-precheck tool to validate your design before
submission.

Examples:
cf precheck # Run all checks
cf precheck --disable-lvs # Skip LVS, run specific checks
cf precheck --checks license --checks makefile # Run specific checks
cf precheck # Run all checks
cf precheck --skip-checks lvs # Skip LVS check
cf precheck --magic-drc # Include optional Magic DRC
cf precheck --checks topcell_check # Run specific checks only
"""
# If .cf/project.json exists in cwd, use it as default project_root
cwd_root, _ = get_project_json_from_cwd()
if not project_root and cwd_root:
project_root = cwd_root
Expand All @@ -3239,20 +3217,17 @@ def precheck(project_root, disable_lvs, checks, dry_run):

project_root_path = Path(project_root)

# Check if project is initialized (allow graceful return)
if not check_project_initialized(project_root_path, 'precheck', dry_run=dry_run, allow_graceful=True):
console.print(f"[red]✗[/red] Project not initialized. Please run 'cf init' first.")
console.print("[yellow]Dependencies are required before running precheck.[/yellow]")
return

project_json_path = project_root_path / '.cf' / 'project.json'

# Check project type - GPIO config not needed for openframe
with open(project_json_path, 'r') as f:
project_data = json.load(f)
project_type = project_data.get('project', {}).get('type', 'digital')

# Check if GPIO configuration exists (not needed for openframe)
if project_type != 'openframe':
gpio_config = get_gpio_config_from_project_json(str(project_json_path))
if not gpio_config or len(gpio_config) == 0:
Expand All @@ -3261,10 +3236,8 @@ def precheck(project_root, disable_lvs, checks, dry_run):
console.print("[cyan]Please run 'cf gpio-config' to configure GPIO settings first.[/cyan]")
raise click.Abort()

precheck_root = Path.home() / 'mpw_precheck'
pdk_root = project_root_path / 'dependencies' / 'pdks'

# Detect PDK from project.json
pdk = 'sky130A'
if project_json_path.exists():
try:
Expand All @@ -3274,124 +3247,98 @@ def precheck(project_root, disable_lvs, checks, dry_run):
except:
pass

# Check if precheck is installed
if not precheck_root.exists():
console.print(f"[red]✗[/red] mpw_precheck not found at {precheck_root}")
console.print("[yellow]Run 'cf setup --only-precheck' to install[/yellow]")
return

# Check if PDK exists
if not (pdk_root / pdk).exists():
console.print(f"[red]✗[/red] PDK not found at {pdk_root / pdk}")
console.print("[yellow]Run 'cf setup --only-pdk' to install[/yellow]")
return

# Check Docker availability
docker_available = shutil.which('docker') is not None
if not docker_available:
if shutil.which('docker') is None:
console.print("[red]✗[/red] Docker not found. Docker is required to run precheck.")
return

# Build the checks list
if checks:
# User specified custom checks
checks_list = list(checks)
elif disable_lvs:
# Default checks when LVS is disabled
checks_list = [
'license', 'makefile', 'default', 'documentation', 'consistency',
'gpio_defines', 'xor', 'magic_drc', 'klayout_feol', 'klayout_beol',
'klayout_offgrid', 'klayout_met_min_ca_density',
'klayout_pin_label_purposes_overlapping_drawing', 'klayout_zeroarea'
]
else:
# All checks (default behavior)
checks_list = []

# Display configuration
console.print("\n" + "="*60)
console.print("[bold cyan]MPW Precheck[/bold cyan]")
console.print(f"Project: [yellow]{project_root_path}[/yellow]")
console.print(f"PDK: [yellow]{pdk}[/yellow]")
if disable_lvs:
console.print("Mode: [yellow]LVS disabled[/yellow]")
if checks_list:
console.print(f"Checks: [yellow]{', '.join(checks_list)}[/yellow]")
else:
console.print("Checks: [yellow]All checks[/yellow]")
console.print("="*60 + "\n")

# Build Docker command
import getpass
import pwd

user_id = os.getuid()
group_id = os.getgid()

pdk_path = pdk_root / pdk
pdkpath = pdk_path # Same as PDK_PATH in the Makefile
ipm_dir = Path.home() / '.ipm'

# Create .ipm directory if it doesn't exist
if not ipm_dir.exists():
ipm_dir.mkdir(parents=True, exist_ok=True)
docker_image = 'chipfoundry/mpw_precheck:latest'

docker_cmd = [
'docker', 'run', '--rm',
'-v', f'{precheck_root}:{precheck_root}',
'-v', f'{project_root_path}:{project_root_path}',
'-v', f'{pdk_root}:{pdk_root}',
'-v', f'{ipm_dir}:{ipm_dir}',
'-e', f'INPUT_DIRECTORY={project_root_path}',
'-e', f'PDK_PATH={pdk_path}',
'-e', f'PDK_ROOT={pdk_root}',
'-e', f'PDKPATH={pdkpath}',
'-u', f'{user_id}:{group_id}',
'chipfoundry/mpw_precheck:latest',
'bash', '-c',
docker_image,
'cf-precheck',
'-i', str(project_root_path),
'-p', str(pdk_path),
'-c', '/opt/caravel',
]

# Build the precheck command
precheck_cmd = f'cd {precheck_root} ; python3 mpw_precheck.py --input_directory {project_root_path} --pdk_path {pdk_path}'
if magic_drc:
docker_cmd.append('--magic-drc')

if skip_checks:
docker_cmd.extend(['--skip-checks'] + list(skip_checks))

if checks_list:
precheck_cmd += ' ' + ' '.join(checks_list)
if checks:
docker_cmd.extend(list(checks))

docker_cmd.append(precheck_cmd)
checks_display = ', '.join(checks) if checks else 'All checks'
console.print("\n" + "="*60)
console.print("[bold cyan]CF Precheck[/bold cyan]")
console.print(f"Project: [yellow]{project_root_path}[/yellow]")
console.print(f"PDK: [yellow]{pdk}[/yellow]")
if skip_checks:
console.print(f"Skipping: [yellow]{', '.join(skip_checks)}[/yellow]")
if magic_drc:
console.print("Magic DRC: [yellow]enabled[/yellow]")
console.print(f"Checks: [yellow]{checks_display}[/yellow]")
console.print("="*60 + "\n")

if dry_run:
console.print("[bold yellow]Dry run - would execute:[/bold yellow]\n")
console.print("[dim]" + ' '.join(docker_cmd) + "[/dim]")
return

# Run precheck
console.print("[cyan]Running mpw_precheck...[/cyan]")
# Pull/update Docker image before running
console.print(f"[cyan]Checking for Docker image updates...[/cyan]")
try:
subprocess.run(
['docker', 'pull', docker_image],
check=True,
capture_output=True,
)
console.print(f"[green]✓[/green] Docker image up to date")
except subprocess.CalledProcessError:
# Image might already be available locally, warn but continue
result = subprocess.run(
['docker', 'image', 'inspect', docker_image],
capture_output=True,
)
if result.returncode != 0:
console.print(f"[red]✗[/red] Docker image '{docker_image}' not found. Run 'cf setup --only-precheck' or check your connection.")
return
console.print("[yellow]⚠[/yellow] Could not check for image updates (using cached image)")

console.print("[cyan]Running cf-precheck...[/cyan]\n")

try:
# Use Popen for better signal handling
process = subprocess.Popen(
docker_cmd,
cwd=str(precheck_root),
preexec_fn=os.setsid if os.name != 'nt' else None
)

# Wait for process to complete
returncode = process.wait()

console.print("") # Add newline
console.print("")
if returncode == 0:
console.print("[green]✓[/green] Precheck passed!")
elif returncode == -2 or returncode == 130: # SIGINT
elif returncode == -2 or returncode == 130:
console.print("[yellow]⚠[/yellow] Precheck interrupted by user")
sys.exit(130)
else:
console.print(f"[red]✗[/red] Precheck failed with exit code {returncode}")
console.print(f"[yellow]Check the output above for details[/yellow]")
console.print(f"[red]✗[/red] Precheck failed (exit code {returncode})")
sys.exit(returncode)

except KeyboardInterrupt:
console.print("\n[yellow]⚠[/yellow] Precheck interrupted by user")
# Try to stop the Docker container gracefully
try:
if os.name != 'nt':
os.killpg(os.getpgid(process.pid), signal.SIGTERM)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "chipfoundry-cli"
version = "2.1.1"
version = "2.2.0"
description = "CLI tool to automate ChipFoundry project submission to SFTP server"
authors = ["ChipFoundry <marwan.abbas@chipfoundry.io>"]
readme = "README.md"
Expand Down
34 changes: 21 additions & 13 deletions tests/test_precheck_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@ def test_precheck_help(self):
result = runner.invoke(main, ['precheck', '--help'])

assert result.exit_code == 0
assert 'Run mpw_precheck validation' in result.output
assert 'Run precheck validation' in result.output
assert '--project-root' in result.output
assert '--disable-lvs' in result.output
assert '--skip-checks' in result.output
assert '--magic-drc' in result.output
assert '--checks' in result.output
assert '--dry-run' in result.output

Expand All @@ -44,24 +45,20 @@ def test_precheck_dry_run(self, temp_project_dir):
'--dry-run'
])

# Command returns 0 even on error, just prints error message
assert result.exit_code == 0
# May mention precheck, pdk, or setup in error message
assert any(keyword in result.output.lower() for keyword in ['precheck', 'pdk', 'setup', 'dry'])

def test_precheck_disable_lvs(self, temp_project_dir):
"""Test precheck command with --disable-lvs flag."""
def test_precheck_skip_checks(self, temp_project_dir):
"""Test precheck command with --skip-checks flag."""
runner = CliRunner()
result = runner.invoke(main, [
'precheck',
'--project-root', temp_project_dir,
'--disable-lvs',
'--skip-checks', 'lvs',
'--dry-run'
])

# Command returns 0 even on error, just prints error message
assert result.exit_code == 0
# May mention precheck, pdk, or setup in error message
assert any(keyword in result.output.lower() for keyword in ['precheck', 'pdk', 'setup', 'dry'])

def test_precheck_with_checks(self, temp_project_dir):
Expand All @@ -70,14 +67,25 @@ def test_precheck_with_checks(self, temp_project_dir):
result = runner.invoke(main, [
'precheck',
'--project-root', temp_project_dir,
'--checks', 'license',
'--checks', 'makefile',
'--checks', 'topcell_check',
'--checks', 'gpio_defines',
'--dry-run'
])

assert result.exit_code == 0
assert any(keyword in result.output.lower() for keyword in ['precheck', 'pdk', 'setup', 'dry'])

def test_precheck_magic_drc(self, temp_project_dir):
"""Test precheck command with --magic-drc flag."""
runner = CliRunner()
result = runner.invoke(main, [
'precheck',
'--project-root', temp_project_dir,
'--magic-drc',
'--dry-run'
])

# Command returns 0 even on error, just prints error message
assert result.exit_code == 0
# May mention precheck, pdk, or setup in error message
assert any(keyword in result.output.lower() for keyword in ['precheck', 'pdk', 'setup', 'dry'])


Expand Down
Loading