5 Commits

Author SHA1 Message Date
Eric Ratliff
e605b1cd3e Updating project to v1.1.0-beta.2.
- Project is running very well on Linux
- Project needs to be tested fully in Windows
2026-02-01 21:36:20 -06:00
Eric Ratliff
26f3229b1e docs: update README for v1.1.0 features
Document proxy support and Android Studio integration added in v1.1.0.

New sections:
- Proxy Support: --proxy and --no-proxy flags, HTTPS_PROXY env var
  auto-detection, air-gapped/offline installation workflows
- Android Studio Setup: complete guide including Shell Script plugin
  installation, opening projects, and using run configurations
- Troubleshooting: Android Studio plugin issues, proxy debugging

Updated sections:
- Quick Start: add weevil setup and weevil doctor as step 1
- Command Reference: environment commands (doctor, setup, uninstall),
  global proxy flags
- Features: highlight Android Studio integration and proxy support
- Project Status: current version 1.1.0, updated "What Works" list

Expanded troubleshooting for common issues: adb not found, proxy
connectivity, Android Studio run configuration errors.

All existing content preserved. Tone stays practical and student-focused.
2026-02-01 20:56:52 -06:00
Eric Ratliff
9ee0d99dd8 feat: add Android Studio integration (v1.1.0)
Generate .idea/ run configurations for one-click build and deployment
directly from Android Studio. Students can now open projects in the IDE
they already know and hit the green play button to deploy to their robot.

Run configurations generated:
- Build: compiles APK without deploying (build.sh / build.bat)
- Deploy (auto): auto-detects USB or WiFi connection
- Deploy (USB): forces USB deployment (deploy.sh --usb)
- Deploy (WiFi): forces WiFi deployment (deploy.sh --wifi)
- Test: runs unit tests (./gradlew test)

Both Unix (.sh) and Windows (.bat) variants are generated. Android Studio
automatically hides the configurations whose script files don't exist, so
only platform-appropriate configs appear in the Run dropdown.

workspace.xml configures the project tree to hide internal directories
(build/, .gradle/, gradle/) and expand src/ by default, giving students
a clean view of just their code and the deployment scripts.

Technical notes:
- Uses ShConfigurationType (not the old ShellScript type) for Android
  Studio 2025.2+ compatibility
- All paths use $PROJECT_DIR$ for portability
- INTERPRETER_PATH is /bin/bash on Unix, cmd.exe on Windows
- upgrade.rs regenerates all .idea/ files so run configs stay in sync
  with any future deploy.sh flag changes

Requires Shell Script plugin (by JetBrains) to be installed in Android
Studio. README.md updated with installation instructions.

Files modified:
- src/project/mod.rs: generate_idea_files() writes 5 XML files per platform
- src/commands/upgrade.rs: add .idea/ files to safe_to_overwrite
2026-02-01 20:56:03 -06:00
Eric Ratliff
58f7962a2a v1.1.0-beta.1: add proxy integration tests (62 tests, all green)
Nine end-to-end tests for the proxy feature: 6 network tests exercising
every proxy code path through a real hyper forward proxy (TestProxy) and
a mockito origin, plus 3 CLI tests verifying flag parsing and error handling.

TestProxy binds to 127.0.0.1:0, forwards in absolute-form, counts requests
via an atomic so we can assert traffic actually traversed the proxy.

Key issues resolved during implementation:

- ENV_MUTEX serializes all tests that mutate HTTPS_PROXY/HTTP_PROXY in both
  the unit test module and the integration suite. Without it, parallel test
  execution within a single binary produces nondeterministic failures.

- reqwest's blocking::Client owns an internal tokio Runtime. Dropping it
  inside a #[tokio::test] async fn panics on tokio >= 1.49. All reqwest
  work runs inside spawn_blocking so the Client drops on a thread-pool
  thread where that's permitted.

- service_fn's closure can't carry a return-type annotation, and async
  blocks don't support one either. The handler is extracted to a named
  async fn (proxy_handler) so the compiler can see the concrete
  Result<Response, Infallible> and satisfy serve_connection's Error bound.
2026-02-01 10:21:11 -06:00
Eric Ratliff
54647a47b1 feat: add proxy support for SDK downloads (v1.1.0)
Add --proxy and --no-proxy global flags to control HTTP/HTTPS proxy
usage for all network operations (SDK installs, FTC SDK clone/fetch,
Android SDK download).

Proxy resolution priority:
  1. --no-proxy          → go direct, ignore everything
  2. --proxy <url>       → use the specified proxy
  3. HTTPS_PROXY / HTTP_PROXY env vars (auto-detected)
  4. Nothing             → go direct

Key implementation details:
- reqwest client is always built through ProxyConfig::client() rather
  than Client::new(), so --no-proxy actively suppresses env-var
  auto-detection instead of just being a no-op.
- git2/libgit2 has its own HTTP transport that doesn't use reqwest.
  GitProxyGuard is an RAII guard that temporarily sets/clears the
  HTTPS_PROXY env vars around clone and fetch operations, then restores
  the previous state on drop. This avoids mutating ~/.gitconfig.
- Gradle wrapper reads HTTPS_PROXY natively; no programmatic
  intervention needed.
- All network failure paths now print offline/air-gapped installation
  instructions automatically, covering manual SDK installs and Gradle
  distribution download.

Closes: v1.1.0 proxy support milestone
2026-02-01 09:47:52 -06:00
15 changed files with 2141 additions and 75 deletions

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "weevil" name = "weevil"
version = "1.1.0-beta.1" version = "1.1.0-beta.2"
edition = "2021" edition = "2021"
authors = ["Eric Ratliff <eric@nxlearn.net>"] authors = ["Eric Ratliff <eric@nxlearn.net>"]
description = "FTC robotics project generator - bores into complexity, emerges with clean code" description = "FTC robotics project generator - bores into complexity, emerges with clean code"
@@ -63,6 +63,17 @@ assert_cmd = "2.0"
predicates = "3.1" predicates = "3.1"
insta = "1.41" insta = "1.41"
# Proxy integration tests: mockito is the mock origin server; hyper + friends
# are the forward proxy. All three are already in Cargo.lock as transitive
# deps of reqwest — we're just promoting them to explicit dev-deps with the
# features we actually need.
mockito = "1.7"
hyper = { version = "1", features = ["server", "http1", "client"] }
hyper-util = { version = "0.1", features = ["tokio", "client-legacy", "http1"] }
http-body-util = "0.1"
bytes = "1"
tokio = { version = "1", features = ["full"] }
[build-dependencies] [build-dependencies]
ureq = { version = "2.10", features = ["json"] } ureq = { version = "2.10", features = ["json"] }
zip = "2.2" zip = "2.2"

273
README.md
View File

@@ -26,6 +26,8 @@ This approach works against standard software engineering practices and creates
- ✅ Generate all build/deploy scripts automatically - ✅ Generate all build/deploy scripts automatically
- ✅ Enable proper version control workflows - ✅ Enable proper version control workflows
- ✅ Are actually testable and maintainable - ✅ Are actually testable and maintainable
- ✅ Work seamlessly with Android Studio
- ✅ Support proxy/air-gapped environments
Students focus on building robots, not navigating SDK internals. Students focus on building robots, not navigating SDK internals.
@@ -39,6 +41,7 @@ my-robot/
├── src/ ├── src/
│ ├── main/java/robot/ # Your robot code lives here │ ├── main/java/robot/ # Your robot code lives here
│ └── test/java/robot/ # Unit tests (run on PC!) │ └── test/java/robot/ # Unit tests (run on PC!)
├── .idea/ # Android Studio integration (auto-generated)
├── build.sh / build.bat # One command to build ├── build.sh / build.bat # One command to build
├── deploy.sh / deploy.bat # One command to deploy ├── deploy.sh / deploy.bat # One command to deploy
└── .weevil.toml # Project configuration └── .weevil.toml # Project configuration
@@ -46,6 +49,9 @@ my-robot/
### 🚀 Simple Commands ### 🚀 Simple Commands
```bash ```bash
# Set up development environment
weevil setup
# Create a new robot project # Create a new robot project
weevil new awesome-robot weevil new awesome-robot
@@ -60,6 +66,9 @@ cd awesome-robot
### 🔧 Project Management ### 🔧 Project Management
```bash ```bash
# Check system health
weevil doctor
# Upgrade project infrastructure # Upgrade project infrastructure
weevil upgrade awesome-robot weevil upgrade awesome-robot
@@ -69,8 +78,36 @@ weevil config awesome-robot --set-sdk /path/to/different/sdk
# Check SDK status # Check SDK status
weevil sdk status weevil sdk status
# Remove installed components
weevil uninstall --dry-run
weevil uninstall
``` ```
### 🌐 Proxy Support (v1.1.0)
Work behind corporate firewalls or in air-gapped environments:
```bash
# Use HTTP proxy for all downloads
weevil --proxy http://proxy.company.com:8080 setup
weevil --proxy http://proxy.company.com:8080 new my-robot
# Bypass proxy (for local/direct connections)
weevil --no-proxy setup
# Proxy auto-detected from HTTPS_PROXY/HTTP_PROXY environment variables
export HTTPS_PROXY=http://proxy:8080
weevil setup # Uses proxy automatically
```
### 💻 Android Studio Integration (v1.1.0)
Projects work seamlessly with Android Studio:
- **One-click deployment** - Run configurations appear automatically in the Run dropdown
- **Clean file tree** - Internal directories hidden, only your code visible
- **No configuration needed** - Just open the project and hit Run
See [Android Studio Setup](#android-studio-setup) for details.
### ✨ Smart Features ### ✨ Smart Features
- **Per-project SDK configuration** - Different projects can use different SDK versions - **Per-project SDK configuration** - Different projects can use different SDK versions
- **Automatic Gradle wrapper** - No manual setup required - **Automatic Gradle wrapper** - No manual setup required
@@ -78,6 +115,8 @@ weevil sdk status
- **Zero SDK modification** - Your SDK stays pristine - **Zero SDK modification** - Your SDK stays pristine
- **Git-ready** - Projects initialize with proper `.gitignore` - **Git-ready** - Projects initialize with proper `.gitignore`
- **Upgrade-safe** - Update build scripts without losing code - **Upgrade-safe** - Update build scripts without losing code
- **System diagnostics** - `weevil doctor` checks your environment health
- **Selective uninstall** - Remove specific components without nuking everything
--- ---
@@ -96,30 +135,49 @@ export PATH="$PATH:$(pwd)/target/release"
``` ```
### Prerequisites ### Prerequisites
- Rust 1.70+ (for building) - Rust 1.70+ (for building Weevil)
- Java 11+ (for running Gradle) - Java 11+ (for running Gradle)
- Android SDK with platform-tools (for deployment) - Android SDK with platform-tools (for deployment)
- FTC SDK (Weevil can download it for you) - FTC SDK (Weevil can install it for you)
--- ---
## Quick Start ## Quick Start
### 1. Create Your First Project ### 1. Set Up Your Environment
```bash
# Check what's installed
weevil doctor
# Install everything automatically
weevil setup
# Or install to custom location
weevil setup --ftc-sdk ~/my-sdks/ftc --android-sdk ~/my-sdks/android
```
Weevil will:
- Download and install FTC SDK
- Download and install Android SDK (if needed)
- Set up Gradle wrapper
- Verify all dependencies
### 2. Create Your First Project
```bash ```bash
weevil new my-robot weevil new my-robot
cd my-robot cd my-robot
``` ```
Weevil will: Weevil generates:
- Download the FTC SDK if needed (or use existing) - Clean project structure
- Generate your project structure - Android Studio run configurations
- Set up Gradle wrapper - Example test files
- Initialize git repository - Build and deploy scripts
- Create example test files - Git repository with `.gitignore`
### 2. Write Some Code ### 3. Write Some Code
Create `src/main/java/robot/MyOpMode.java`: Create `src/main/java/robot/MyOpMode.java`:
@@ -146,7 +204,7 @@ public class MyOpMode extends LinearOpMode {
} }
``` ```
### 3. Test Locally (No Robot!) ### 4. Test Locally (No Robot!)
```bash ```bash
./gradlew test ./gradlew test
@@ -154,7 +212,7 @@ public class MyOpMode extends LinearOpMode {
Write unit tests in `src/test/java/robot/` that run on your PC. No need to deploy to a robot for every code change! Write unit tests in `src/test/java/robot/` that run on your PC. No need to deploy to a robot for every code change!
### 4. Deploy to Robot ### 5. Deploy to Robot
```bash ```bash
# Build APK # Build APK
@@ -172,8 +230,93 @@ Write unit tests in `src/test/java/robot/` that run on your PC. No need to deplo
--- ---
## Android Studio Setup
### Opening a Weevil Project
1. Launch Android Studio
2. Choose **Open** (not "New Project")
3. Navigate to your project directory (e.g., `my-robot`)
4. Click OK
Android Studio will index the project. After a few seconds, you'll see:
- **Clean file tree** - Only `src/`, scripts, and essential files visible
- **Run configurations** - Dropdown next to the green play button shows:
- **Build** - Builds APK without deploying
- **Deploy (auto)** - Auto-detects USB or WiFi
- **Deploy (USB)** - Forces USB connection
- **Deploy (WiFi)** - Forces WiFi connection
- **Test** - Runs unit tests
### First-Time Setup: Shell Script Plugin
**Important:** Android Studio requires the Shell Script plugin to run Weevil's deployment scripts.
1. Go to **File → Settings** (or **Ctrl+Alt+S**)
2. Navigate to **Plugins**
3. Click the **Marketplace** tab
4. Search for **"Shell Script"**
5. Install the plugin (by JetBrains)
6. Restart Android Studio
After restart, the run configurations will work.
### Running from Android Studio
1. Select a configuration from the dropdown (e.g., "Deploy (auto)")
2. Click the green play button (▶) or press **Shift+F10**
3. Watch the output in the Run panel at the bottom
**That's it!** Students can now build and deploy without leaving the IDE.
### Platform Notes
- **Linux/macOS:** Uses the Unix run configurations (`.sh` scripts)
- **Windows:** Uses the Windows run configurations (`.bat` scripts)
- Android Studio automatically hides the configurations for the other platform
---
## Advanced Usage ## Advanced Usage
### Proxy Configuration
#### Corporate Environments
```bash
# Set proxy for all Weevil operations
weevil --proxy http://proxy.company.com:8080 setup
weevil --proxy http://proxy.company.com:8080 new robot-project
# Or use environment variables (auto-detected)
export HTTPS_PROXY=http://proxy:8080
export HTTP_PROXY=http://proxy:8080
weevil setup # Automatically uses proxy
```
#### Air-Gapped / Offline Installation
If you're on an isolated network without internet:
1. **Download SDKs manually on a connected machine:**
- FTC SDK: `git clone https://github.com/FIRST-Tech-Challenge/FtcRobotController.git`
- Android SDK: Download from https://developer.android.com/studio
- Gradle: Download distribution from https://gradle.org/releases/
2. **Transfer to isolated machine via USB drive**
3. **Install using local paths:**
```bash
weevil setup --ftc-sdk /path/to/FtcRobotController --android-sdk /path/to/android-sdk
```
#### Bypass Proxy
```bash
# Force direct connection (ignore proxy environment variables)
weevil --no-proxy setup
```
### Multiple SDK Versions ### Multiple SDK Versions
Working with multiple SDK versions? No problem: Working with multiple SDK versions? No problem:
@@ -203,10 +346,27 @@ This updates:
- Build scripts - Build scripts
- Deployment scripts - Deployment scripts
- Gradle configuration - Gradle configuration
- Android Studio run configurations
- Project templates - Project templates
**Your code in `src/` is never touched.** **Your code in `src/` is never touched.**
### System Maintenance
```bash
# Check what's installed
weevil doctor
# See what can be uninstalled
weevil uninstall --dry-run
# Remove specific components
weevil uninstall --only 1 # Removes FTC SDK only
# Full uninstall (removes everything Weevil installed)
weevil uninstall
```
### Cross-Platform Development ### Cross-Platform Development
All scripts work on Windows, Linux, and macOS: All scripts work on Windows, Linux, and macOS:
@@ -220,9 +380,11 @@ All scripts work on Windows, Linux, and macOS:
**Windows:** **Windows:**
```cmd ```cmd
build.bat build.bat
deploy.bat --wifi deploy.bat
``` ```
**Android Studio:** Works identically on all platforms
--- ---
## Project Configuration ## Project Configuration
@@ -231,9 +393,10 @@ Each project has a `.weevil.toml` file:
```toml ```toml
project_name = "my-robot" project_name = "my-robot"
weevil_version = "1.0.0" weevil_version = "1.1.0"
ftc_sdk_path = "/home/user/.weevil/ftc-sdk" ftc_sdk_path = "/home/user/.weevil/ftc-sdk"
ftc_sdk_version = "v10.1.1" ftc_sdk_version = "v10.1.1"
android_sdk_path = "/home/user/.weevil/android-sdk"
``` ```
You can edit this manually or use: You can edit this manually or use:
@@ -273,6 +436,7 @@ git push
1. **Unit Tests** - Test business logic on your PC 1. **Unit Tests** - Test business logic on your PC
```bash ```bash
./gradlew test ./gradlew test
# Or from Android Studio: select "Test" and click Run
``` ```
2. **Integration Tests** - Test on actual hardware 2. **Integration Tests** - Test on actual hardware
@@ -293,7 +457,7 @@ cd robot
# Check SDK location # Check SDK location
weevil config . weevil config .
# Set SDK to local path # Set SDK to local path (if different from .weevil.toml)
weevil config . --set-sdk ~/ftc-sdk weevil config . --set-sdk ~/ftc-sdk
# Build and deploy # Build and deploy
@@ -301,15 +465,29 @@ weevil config . --set-sdk ~/ftc-sdk
./deploy.sh ./deploy.sh
``` ```
**Android Studio users:** Just open the project. The `.idea/` folder contains all run configurations.
--- ---
## Command Reference ## Command Reference
### Environment Commands
| Command | Description |
|---------|-------------|
| `weevil doctor` | Check system health and dependencies |
| `weevil setup` | Install FTC SDK, Android SDK, and dependencies |
| `weevil setup --ftc-sdk <path>` | Install to custom FTC SDK location |
| `weevil uninstall` | Remove all Weevil-managed components |
| `weevil uninstall --dry-run` | Show what would be removed |
| `weevil uninstall --only <N>` | Remove specific component by index |
### Project Commands ### Project Commands
| Command | Description | | Command | Description |
|---------|-------------| |---------|-------------|
| `weevil new <name>` | Create new FTC project | | `weevil new <name>` | Create new FTC project |
| `weevil new <name> --ftc-sdk <path>` | Create with specific SDK |
| `weevil upgrade <path>` | Update project infrastructure | | `weevil upgrade <path>` | Update project infrastructure |
| `weevil config <path>` | View project configuration | | `weevil config <path>` | View project configuration |
| `weevil config <path> --set-sdk <sdk>` | Change FTC SDK path | | `weevil config <path> --set-sdk <sdk>` | Change FTC SDK path |
@@ -322,6 +500,13 @@ weevil config . --set-sdk ~/ftc-sdk
| `weevil sdk install` | Download and install SDKs | | `weevil sdk install` | Download and install SDKs |
| `weevil sdk update` | Update SDKs to latest versions | | `weevil sdk update` | Update SDKs to latest versions |
### Global Flags
| Flag | Description |
|------|-------------|
| `--proxy <url>` | Use HTTP proxy for all network operations |
| `--no-proxy` | Bypass proxy (ignore HTTPS_PROXY env vars) |
### Deployment Options ### Deployment Options
**`deploy.sh` / `deploy.bat` flags:** **`deploy.sh` / `deploy.bat` flags:**
@@ -343,6 +528,7 @@ weevil config . --set-sdk ~/ftc-sdk
- Creates standalone Java project structure - Creates standalone Java project structure
- Generates Gradle build files that reference FTC SDK - Generates Gradle build files that reference FTC SDK
- Sets up deployment scripts - Sets up deployment scripts
- Creates Android Studio run configurations
2. **Build Process** 2. **Build Process**
- Runs `deployToSDK` Gradle task - Runs `deployToSDK` Gradle task
@@ -355,12 +541,18 @@ weevil config . --set-sdk ~/ftc-sdk
- Connects to Control Hub (USB or WiFi) - Connects to Control Hub (USB or WiFi)
- Installs APK using `adb` - Installs APK using `adb`
4. **Proxy Support**
- reqwest HTTP client respects `--proxy` flag and HTTPS_PROXY env vars
- git2/libgit2 gets temporary proxy env vars during clone/fetch
- Gradle wrapper reads HTTPS_PROXY natively
### Why This Approach? ### Why This Approach?
**Separation of Concerns:** **Separation of Concerns:**
- Your code: `my-robot/src/` - Your code: `my-robot/src/`
- Build infrastructure: `my-robot/*.gradle.kts` - Build infrastructure: `my-robot/*.gradle.kts`
- FTC SDK: System-level installation - FTC SDK: System-level installation
- IDE integration: Auto-generated, auto-upgraded
**Benefits:** **Benefits:**
- Test code without SDK complications - Test code without SDK complications
@@ -368,6 +560,7 @@ weevil config . --set-sdk ~/ftc-sdk
- SDK updates don't break your projects - SDK updates don't break your projects
- Proper version control (no massive SDK in repo) - Proper version control (no massive SDK in repo)
- Industry-standard project structure - Industry-standard project structure
- Students use familiar tools (Android Studio)
--- ---
@@ -382,6 +575,7 @@ cargo test
# Run specific test suites # Run specific test suites
cargo test --test integration cargo test --test integration
cargo test --test project_lifecycle cargo test --test project_lifecycle
cargo test --test proxy_integration
cargo test config_tests cargo test config_tests
``` ```
@@ -392,6 +586,8 @@ cargo test config_tests
- ✅ Build script generation - ✅ Build script generation
- ✅ Upgrade workflow - ✅ Upgrade workflow
- ✅ CLI commands - ✅ CLI commands
- ✅ Proxy configuration and network operations
- ✅ Environment setup and health checks
--- ---
@@ -400,11 +596,11 @@ cargo test config_tests
### "FTC SDK not found" ### "FTC SDK not found"
```bash ```bash
# Check SDK status # Check system health
weevil sdk status weevil doctor
# Install SDK # Install SDK
weevil sdk install weevil setup
# Or specify custom location # Or specify custom location
weevil new my-robot --ftc-sdk /custom/path/to/sdk weevil new my-robot --ftc-sdk /custom/path/to/sdk
@@ -416,6 +612,10 @@ Install Android platform-tools:
**Linux:** **Linux:**
```bash ```bash
# Weevil can install it for you
weevil setup
# Or install manually
sudo apt install android-tools-adb sudo apt install android-tools-adb
``` ```
@@ -425,7 +625,7 @@ brew install android-platform-tools
``` ```
**Windows:** **Windows:**
Download Android SDK Platform Tools from Google. Download Android SDK Platform Tools from Google or run `weevil setup`.
### "Build failed" ### "Build failed"
@@ -437,6 +637,9 @@ cd my-robot
# Check SDK path # Check SDK path
weevil config . weevil config .
# Verify system health
weevil doctor
``` ```
### "Deploy failed - No devices" ### "Deploy failed - No devices"
@@ -451,6 +654,24 @@ weevil config .
2. Find Control Hub IP (usually 192.168.43.1 or 192.168.49.1) 2. Find Control Hub IP (usually 192.168.43.1 or 192.168.49.1)
3. Try `./deploy.sh -i <ip>` 3. Try `./deploy.sh -i <ip>`
### Android Studio: "Unknown run configuration type ShellScript"
The Shell Script plugin is not installed. See [Android Studio Setup](#android-studio-setup) for installation instructions.
### Proxy Issues
```bash
# Test proxy connectivity
weevil --proxy http://proxy:8080 sdk status
# Bypass proxy if it's causing issues
weevil --no-proxy setup
# Check environment variables
echo $HTTPS_PROXY
echo $HTTP_PROXY
```
--- ---
## Contributing ## Contributing
@@ -490,6 +711,7 @@ Like the boll weevil that bores through complex cotton bolls to reach the valuab
3. **Testability** - Enable TDD and proper testing workflows 3. **Testability** - Enable TDD and proper testing workflows
4. **Simplicity** - One command should do one obvious thing 4. **Simplicity** - One command should do one obvious thing
5. **Transparency** - Students should understand what's happening 5. **Transparency** - Students should understand what's happening
6. **Tool compatibility** - Work with tools students already know
--- ---
@@ -511,22 +733,27 @@ Built with frustration at unnecessarily complex robotics frameworks, and hope th
## Project Status ## Project Status
**Current Version:** 1.0.0 **Current Version:** 1.1.0
**What Works:** **What Works:**
- ✅ Project generation - ✅ Project generation
- ✅ Cross-platform build/deploy - ✅ Cross-platform build/deploy
- ✅ SDK management - ✅ SDK management and auto-install
- ✅ Configuration management - ✅ Configuration management
- ✅ Project upgrades - ✅ Project upgrades
- ✅ Local testing - ✅ Local unit testing
- ✅ System diagnostics (`weevil doctor`)
- ✅ Selective uninstall
- ✅ Proxy support for corporate/air-gapped environments
- ✅ Android Studio integration with one-click deployment
**Roadmap:** **Roadmap:**
- 📋 Package management for FTC libraries - 📋 Package management for FTC libraries
- 📋 Template system for common robot configurations - 📋 Template system for common robot configurations
- 📋 IDE integration (VS Code, IntelliJ) - 📋 VS Code integration
- 📋 Team collaboration features - 📋 Team collaboration features
- 📋 Automated testing on robot hardware - 📋 Automated testing on robot hardware
- 📋 Multi-robot support (manage multiple Control Hubs)
--- ---

755
diff.txt Normal file
View File

@@ -0,0 +1,755 @@
diff --git i/src/commands/new.rs w/src/commands/new.rs
index aeed30a..4d219c6 100644
--- i/src/commands/new.rs
+++ w/src/commands/new.rs
@@ -3,12 +3,14 @@
use colored::*;
use crate::sdk::SdkConfig;
+use crate::sdk::proxy::ProxyConfig;
use crate::project::ProjectBuilder;
pub fn create_project(
name: &str,
ftc_sdk: Option<&str>,
android_sdk: Option<&str>,
+ proxy: &ProxyConfig,
) -> Result<()> {
// Validate project name
if name.is_empty() {
@@ -32,6 +34,7 @@ pub fn create_project(
}
println!("{}", format!("Creating FTC project: {}", name).bright_green().bold());
+ proxy.print_status();
println!();
// Check system health FIRST
diff --git i/src/commands/sdk.rs w/src/commands/sdk.rs
index ddc3aa6..250b844 100644
--- i/src/commands/sdk.rs
+++ w/src/commands/sdk.rs
@@ -1,18 +1,22 @@
use anyhow::Result;
use colored::*;
use crate::sdk::SdkConfig;
+use crate::sdk::proxy::ProxyConfig;
-pub fn install_sdks() -> Result<()> {
+pub fn install_sdks(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Installing SDKs...".bright_yellow().bold());
println!();
+ proxy.print_status();
+ println!();
+
let config = SdkConfig::new()?;
// Install FTC SDK
- crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path)?;
+ crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path, proxy)?;
// Install Android SDK
- crate::sdk::android::install(&config.android_sdk_path)?;
+ crate::sdk::android::install(&config.android_sdk_path, proxy)?;
println!();
println!("{} All SDKs installed successfully", "✓".green().bold());
@@ -44,17 +48,20 @@ pub fn show_status() -> Result<()> {
Ok(())
}
-pub fn update_sdks() -> Result<()> {
+pub fn update_sdks(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Updating SDKs...".bright_yellow().bold());
println!();
+
+ proxy.print_status();
+ println!();
let config = SdkConfig::new()?;
// Update FTC SDK
- crate::sdk::ftc::update(&config.ftc_sdk_path)?;
+ crate::sdk::ftc::update(&config.ftc_sdk_path, proxy)?;
println!();
println!("{} SDKs updated successfully", "✓".green().bold());
Ok(())
-}
+}
\ No newline at end of file
diff --git i/src/commands/setup.rs w/src/commands/setup.rs
index 975b814..cbb5871 100644
--- i/src/commands/setup.rs
+++ w/src/commands/setup.rs
@@ -4,22 +4,26 @@
use colored::*;
use crate::sdk::SdkConfig;
+use crate::sdk::proxy::ProxyConfig;
use crate::project::ProjectConfig;
/// Setup development environment - either system-wide or for a specific project
-pub fn setup_environment(project_path: Option<&str>) -> Result<()> {
+pub fn setup_environment(project_path: Option<&str>, proxy: &ProxyConfig) -> Result<()> {
match project_path {
- Some(path) => setup_project(path),
- None => setup_system(),
+ Some(path) => setup_project(path, proxy),
+ None => setup_system(proxy),
}
}
/// Setup system-wide development environment with default SDKs
-fn setup_system() -> Result<()> {
+fn setup_system(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
println!("{}", " System Setup - Preparing FTC Development Environment".bright_cyan().bold());
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
println!();
+
+ proxy.print_status();
+ println!();
let mut issues = Vec::new();
let mut installed = Vec::new();
@@ -57,18 +61,34 @@ fn setup_system() -> Result<()> {
}
Err(_) => {
println!("{} FTC SDK found but incomplete, reinstalling...", "⚠".yellow());
- crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path)?;
- let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
- .unwrap_or_else(|_| "unknown".to_string());
- installed.push(format!("FTC SDK {} (installed)", version));
+ match crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path, proxy) {
+ Ok(_) => {
+ let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
+ .unwrap_or_else(|_| "unknown".to_string());
+ installed.push(format!("FTC SDK {} (installed)", version));
+ }
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ print_ftc_manual_fallback(&sdk_config);
+ issues.push(("FTC SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
}
} else {
println!("FTC SDK not found. Installing...");
- crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path)?;
- let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
- .unwrap_or_else(|_| "unknown".to_string());
- installed.push(format!("FTC SDK {} (installed)", version));
+ match crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path, proxy) {
+ Ok(_) => {
+ let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
+ .unwrap_or_else(|_| "unknown".to_string());
+ installed.push(format!("FTC SDK {} (installed)", version));
+ }
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ print_ftc_manual_fallback(&sdk_config);
+ issues.push(("FTC SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
println!();
@@ -85,14 +105,26 @@ fn setup_system() -> Result<()> {
}
Err(_) => {
println!("{} Android SDK found but incomplete, reinstalling...", "⚠".yellow());
- crate::sdk::android::install(&sdk_config.android_sdk_path)?;
- installed.push("Android SDK (installed)".to_string());
+ match crate::sdk::android::install(&sdk_config.android_sdk_path, proxy) {
+ Ok(_) => installed.push("Android SDK (installed)".to_string()),
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ print_android_manual_fallback(&sdk_config);
+ issues.push(("Android SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
}
} else {
println!("Android SDK not found. Installing...");
- crate::sdk::android::install(&sdk_config.android_sdk_path)?;
- installed.push("Android SDK (installed)".to_string());
+ match crate::sdk::android::install(&sdk_config.android_sdk_path, proxy) {
+ Ok(_) => installed.push("Android SDK (installed)".to_string()),
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ print_android_manual_fallback(&sdk_config);
+ issues.push(("Android SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
println!();
@@ -132,7 +164,7 @@ fn setup_system() -> Result<()> {
}
/// Setup dependencies for a specific project by reading its .weevil.toml
-fn setup_project(project_path: &str) -> Result<()> {
+fn setup_project(project_path: &str, proxy: &ProxyConfig) -> Result<()> {
let project_path = PathBuf::from(project_path);
if !project_path.exists() {
@@ -143,6 +175,9 @@ fn setup_project(project_path: &str) -> Result<()> {
println!("{}", " Project Setup - Installing Dependencies".bright_cyan().bold());
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
println!();
+
+ proxy.print_status();
+ println!();
// Load project configuration
println!("{}", "Reading project configuration...".bright_yellow());
@@ -214,7 +249,7 @@ fn setup_project(project_path: &str) -> Result<()> {
// Try to install it automatically
println!("{}", "Attempting automatic installation...".bright_yellow());
- match crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path) {
+ match crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path, proxy) {
Ok(_) => {
println!("{} FTC SDK {} installed successfully",
"✓".green(),
@@ -224,13 +259,13 @@ fn setup_project(project_path: &str) -> Result<()> {
}
Err(e) => {
println!("{} Automatic installation failed: {}", "✗".red(), e);
- println!();
- println!("{}", "Manual Installation Required:".bright_yellow().bold());
- println!(" git clone https://github.com/FIRST-Tech-Challenge/FtcRobotController.git \\");
- println!(" {}", config.ftc_sdk_path.display());
- println!(" cd {}", config.ftc_sdk_path.display());
- println!(" git checkout {}", config.ftc_sdk_version);
- bail!("FTC SDK installation failed");
+ let sdk_config = SdkConfig {
+ ftc_sdk_path: config.ftc_sdk_path.clone(),
+ android_sdk_path: config.android_sdk_path.clone(),
+ cache_dir: dirs::home_dir().unwrap_or_default().join(".weevil"),
+ };
+ print_ftc_manual_fallback(&sdk_config);
+ issues.push(("FTC SDK", "See manual installation instructions above.".to_string()));
}
}
}
@@ -249,14 +284,36 @@ fn setup_project(project_path: &str) -> Result<()> {
}
Err(_) => {
println!("{} Android SDK found but incomplete, reinstalling...", "⚠".yellow());
- crate::sdk::android::install(&config.android_sdk_path)?;
- installed.push("Android SDK (installed)".to_string());
+ match crate::sdk::android::install(&config.android_sdk_path, proxy) {
+ Ok(_) => installed.push("Android SDK (installed)".to_string()),
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ let sdk_config = SdkConfig {
+ ftc_sdk_path: config.ftc_sdk_path.clone(),
+ android_sdk_path: config.android_sdk_path.clone(),
+ cache_dir: dirs::home_dir().unwrap_or_default().join(".weevil"),
+ };
+ print_android_manual_fallback(&sdk_config);
+ issues.push(("Android SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
}
} else {
println!("Android SDK not found. Installing...");
- crate::sdk::android::install(&config.android_sdk_path)?;
- installed.push("Android SDK (installed)".to_string());
+ match crate::sdk::android::install(&config.android_sdk_path, proxy) {
+ Ok(_) => installed.push("Android SDK (installed)".to_string()),
+ Err(e) => {
+ println!("{} {}", "✗".red(), e);
+ let sdk_config = SdkConfig {
+ ftc_sdk_path: config.ftc_sdk_path.clone(),
+ android_sdk_path: config.android_sdk_path.clone(),
+ cache_dir: dirs::home_dir().unwrap_or_default().join(".weevil"),
+ };
+ print_android_manual_fallback(&sdk_config);
+ issues.push(("Android SDK", "See manual installation instructions above.".to_string()));
+ }
+ }
}
println!();
@@ -511,4 +568,147 @@ fn print_project_summary(installed: &[String], issues: &[(&str, String)], config
println!(" Then run {} to verify", format!("weevil setup {}", project_path.display()).bright_white());
}
println!();
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Manual fallback instructions — printed when automatic install fails.
+// These walk the user through doing everything by hand, with explicit steps
+// for Linux, macOS, and Windows.
+// ─────────────────────────────────────────────────────────────────────────────
+
+fn print_ftc_manual_fallback(sdk_config: &SdkConfig) {
+ let dest = sdk_config.ftc_sdk_path.display();
+
+ println!();
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!("{}", " Manual FTC SDK Installation".bright_yellow().bold());
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!();
+ println!(" Automatic installation failed. Follow the steps below to");
+ println!(" clone the FTC SDK by hand. If you are behind a proxy, set");
+ println!(" the environment variables shown before running git.");
+ println!();
+ println!(" Target directory: {}", dest);
+ println!();
+
+ println!(" {} Linux / macOS:", "▸".bright_cyan());
+ println!(" # If behind a proxy, set these first (replace with your proxy):");
+ println!(" export HTTPS_PROXY=http://your-proxy:3128");
+ println!(" export HTTP_PROXY=http://your-proxy:3128");
+ println!();
+ println!(" # If the proxy uses a custom CA certificate, add:");
+ println!(" export GIT_SSL_CAPATH=/path/to/ca-certificates");
+ println!(" # (ask your IT department for the CA cert if needed)");
+ println!();
+ println!(" git clone https://github.com/FIRST-Tech-Challenge/FtcRobotController.git \\");
+ println!(" {}", dest);
+ println!(" cd {}", dest);
+ println!(" git checkout v10.1.1");
+ println!();
+
+ println!(" {} Windows (PowerShell):", "▸".bright_cyan());
+ println!(" # If behind a proxy, set these first:");
+ println!(" $env:HTTPS_PROXY = \"http://your-proxy:3128\"");
+ println!(" $env:HTTP_PROXY = \"http://your-proxy:3128\"");
+ println!();
+ println!(" # If the proxy uses a custom CA certificate:");
+ println!(" git config --global http.sslCAInfo C:\\path\\to\\ca-bundle.crt");
+ println!(" # (ask your IT department for the CA cert if needed)");
+ println!();
+ println!(" git clone https://github.com/FIRST-Tech-Challenge/FtcRobotController.git `");
+ println!(" {}", dest);
+ println!(" cd {}", dest);
+ println!(" git checkout v10.1.1");
+ println!();
+
+ println!(" Once done, run {} again.", "weevil setup".bright_white());
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!();
+}
+
+fn print_android_manual_fallback(sdk_config: &SdkConfig) {
+ let dest = sdk_config.android_sdk_path.display();
+
+ // Pick the right download URL for the current OS
+ let (url, extract_note) = if cfg!(target_os = "windows") {
+ (
+ "https://dl.google.com/android/repository/commandlinetools-win-11076708_latest.zip",
+ "Extract the zip. You will get a cmdline-tools/ folder."
+ )
+ } else if cfg!(target_os = "macos") {
+ (
+ "https://dl.google.com/android/repository/commandlinetools-mac-11076708_latest.zip",
+ "Extract the zip. You will get a cmdline-tools/ folder."
+ )
+ } else {
+ (
+ "https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip",
+ "Extract the zip. You will get a cmdline-tools/ folder."
+ )
+ };
+
+ println!();
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!("{}", " Manual Android SDK Installation".bright_yellow().bold());
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!();
+ println!(" Automatic installation failed. Follow the steps below to");
+ println!(" download and set up the Android SDK by hand.");
+ println!();
+ println!(" Target directory: {}", dest);
+ println!(" Download URL: {}", url);
+ println!();
+
+ println!(" {} Linux / macOS:", "▸".bright_cyan());
+ println!(" # If behind a proxy, set these first:");
+ println!(" export HTTPS_PROXY=http://your-proxy:3128");
+ println!(" export HTTP_PROXY=http://your-proxy:3128");
+ println!();
+ println!(" # If the proxy uses a custom CA cert, add:");
+ println!(" export CURL_CA_BUNDLE=/path/to/ca-bundle.crt");
+ println!(" # (ask your IT department for the CA cert if needed)");
+ println!();
+ println!(" mkdir -p {}", dest);
+ println!(" cd {}", dest);
+ println!(" curl -L -o cmdline-tools.zip \\");
+ println!(" \"{}\"", url);
+ println!(" unzip cmdline-tools.zip");
+ println!(" # {} Move into the expected layout:", extract_note);
+ println!(" mv cmdline-tools cmdline-tools-temp");
+ println!(" mkdir -p cmdline-tools/latest");
+ println!(" mv cmdline-tools-temp/* cmdline-tools/latest/");
+ println!(" rmdir cmdline-tools-temp");
+ println!(" # Accept licenses and install packages:");
+ println!(" ./cmdline-tools/latest/bin/sdkmanager --licenses");
+ println!(" ./cmdline-tools/latest/bin/sdkmanager platform-tools \"platforms;android-34\" \"build-tools;34.0.0\"");
+ println!();
+
+ println!(" {} Windows (PowerShell):", "▸".bright_cyan());
+ println!(" # If behind a proxy, set these first:");
+ println!(" $env:HTTPS_PROXY = \"http://your-proxy:3128\"");
+ println!(" $env:HTTP_PROXY = \"http://your-proxy:3128\"");
+ println!();
+ println!(" # If the proxy uses a custom CA cert:");
+ println!(" # Download the CA cert from your IT department and note its path.");
+ println!(" # PowerShell's Invoke-WebRequest will use the system cert store;");
+ println!(" # you may need to import the cert: ");
+ println!(" # Import-Certificate -FilePath C:\\path\\to\\ca.crt -CertStoreLocation Cert:\\LocalMachine\\Root");
+ println!();
+ println!(" New-Item -ItemType Directory -Path \"{}\" -Force", dest);
+ println!(" cd \"{}\"", dest);
+ println!(" Invoke-WebRequest -Uri \"{}\" -OutFile cmdline-tools.zip", url);
+ println!(" Expand-Archive -Path cmdline-tools.zip -DestinationPath .");
+ println!(" # Move into the expected layout:");
+ println!(" Rename-Item cmdline-tools cmdline-tools-temp");
+ println!(" New-Item -ItemType Directory -Path cmdline-tools\\latest");
+ println!(" Move-Item cmdline-tools-temp\\* cmdline-tools\\latest\\");
+ println!(" Remove-Item cmdline-tools-temp");
+ println!(" # Accept licenses and install packages:");
+ println!(" .\\cmdline-tools\\latest\\bin\\sdkmanager.bat --licenses");
+ println!(" .\\cmdline-tools\\latest\\bin\\sdkmanager.bat platform-tools \"platforms;android-34\" \"build-tools;34.0.0\"");
+ println!();
+
+ println!(" Once done, run {} again.", "weevil setup".bright_white());
+ println!("{}", "═══════════════════════════════════════════════════════════".bright_yellow());
+ println!();
}
\ No newline at end of file
diff --git i/src/main.rs w/src/main.rs
index aa8fce4..35d11f7 100644
--- i/src/main.rs
+++ w/src/main.rs
@@ -35,6 +35,14 @@ enum Commands {
/// Path to Android SDK (optional, will auto-detect or download)
#[arg(long)]
android_sdk: Option<String>,
+
+ /// Use this proxy for all network operations (e.g. http://proxy:3128)
+ #[arg(long)]
+ proxy: Option<String>,
+
+ /// Force direct connection, ignoring proxy env vars
+ #[arg(long)]
+ no_proxy: bool,
},
/// Check system health and diagnose issues
@@ -44,6 +52,14 @@ enum Commands {
Setup {
/// Path to project directory (optional - without it, sets up system)
path: Option<String>,
+
+ /// Use this proxy for all network operations (e.g. http://proxy:3128)
+ #[arg(long)]
+ proxy: Option<String>,
+
+ /// Force direct connection, ignoring proxy env vars
+ #[arg(long)]
+ no_proxy: bool,
},
/// Remove Weevil-installed SDKs and dependencies
@@ -85,6 +101,14 @@ enum Commands {
Sdk {
#[command(subcommand)]
command: SdkCommands,
+
+ /// Use this proxy for all network operations (e.g. http://proxy:3128)
+ #[arg(long)]
+ proxy: Option<String>,
+
+ /// Force direct connection, ignoring proxy env vars
+ #[arg(long)]
+ no_proxy: bool,
},
/// Show or update project configuration
@@ -120,14 +144,16 @@ fn main() -> Result<()> {
print_banner();
match cli.command {
- Commands::New { name, ftc_sdk, android_sdk } => {
- commands::new::create_project(&name, ftc_sdk.as_deref(), android_sdk.as_deref())
+ Commands::New { name, ftc_sdk, android_sdk, proxy, no_proxy } => {
+ let proxy_config = weevil::sdk::proxy::ProxyConfig::resolve(proxy.as_deref(), no_proxy)?;
+ commands::new::create_project(&name, ftc_sdk.as_deref(), android_sdk.as_deref(), &proxy_config)
}
Commands::Doctor => {
commands::doctor::run_diagnostics()
}
- Commands::Setup { path } => {
- commands::setup::setup_environment(path.as_deref())
+ Commands::Setup { path, proxy, no_proxy } => {
+ let proxy_config = weevil::sdk::proxy::ProxyConfig::resolve(proxy.as_deref(), no_proxy)?;
+ commands::setup::setup_environment(path.as_deref(), &proxy_config)
}
Commands::Uninstall { dry_run, only } => {
commands::uninstall::uninstall_dependencies(dry_run, only)
@@ -138,11 +164,14 @@ fn main() -> Result<()> {
Commands::Deploy { path, usb, wifi, ip } => {
commands::deploy::deploy_project(&path, usb, wifi, ip.as_deref())
}
- Commands::Sdk { command } => match command {
- SdkCommands::Install => commands::sdk::install_sdks(),
- SdkCommands::Status => commands::sdk::show_status(),
- SdkCommands::Update => commands::sdk::update_sdks(),
- },
+ Commands::Sdk { command, proxy, no_proxy } => {
+ let proxy_config = weevil::sdk::proxy::ProxyConfig::resolve(proxy.as_deref(), no_proxy)?;
+ match command {
+ SdkCommands::Install => commands::sdk::install_sdks(&proxy_config),
+ SdkCommands::Status => commands::sdk::show_status(),
+ SdkCommands::Update => commands::sdk::update_sdks(&proxy_config),
+ }
+ }
Commands::Config { path, set_sdk } => {
if let Some(sdk_path) = set_sdk {
commands::config::set_sdk(&path, &sdk_path)
@@ -164,4 +193,4 @@ fn print_banner() {
println!("{}", " Nexus Workshops LLC".bright_cyan());
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
println!();
-}
+}
\ No newline at end of file
diff --git i/src/sdk/android.rs w/src/sdk/android.rs
index 596ed74..b91701e 100644
--- i/src/sdk/android.rs
+++ w/src/sdk/android.rs
@@ -6,11 +6,13 @@
use std::io::Write;
use colored::*;
+use super::proxy::ProxyConfig;
+
const ANDROID_SDK_URL_LINUX: &str = "https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip";
const ANDROID_SDK_URL_MAC: &str = "https://dl.google.com/android/repository/commandlinetools-mac-11076708_latest.zip";
const ANDROID_SDK_URL_WINDOWS: &str = "https://dl.google.com/android/repository/commandlinetools-win-11076708_latest.zip";
-pub fn install(sdk_path: &Path) -> Result<()> {
+pub fn install(sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
// Check if SDK exists AND is complete
if sdk_path.exists() {
match verify(sdk_path) {
@@ -42,10 +44,20 @@ pub fn install(sdk_path: &Path) -> Result<()> {
// Download
println!("Downloading from: {}", url);
- let client = Client::new();
+ let client = match &proxy.url {
+ Some(proxy_url) => {
+ println!(" via proxy: {}", proxy_url);
+ Client::builder()
+ .proxy(reqwest::Proxy::all(proxy_url.clone())
+ .context("Failed to configure proxy")?)
+ .build()
+ .context("Failed to build HTTP client")?
+ }
+ None => Client::new(),
+ };
let response = client.get(url)
.send()
- .context("Failed to download Android SDK")?;
+ .context("Failed to download Android SDK. If you are behind a proxy, try --proxy <url> or set HTTPS_PROXY")?;
let total_size = response.content_length().unwrap_or(0);
@@ -104,14 +116,14 @@ pub fn install(sdk_path: &Path) -> Result<()> {
}
// Install required packages
- install_packages(sdk_path)?;
+ install_packages(sdk_path, proxy)?;
println!("{} Android SDK installed successfully", "✓".green());
Ok(())
}
-fn install_packages(sdk_path: &Path) -> Result<()> {
+fn install_packages(sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
println!("Installing Android SDK packages...");
let sdkmanager_path = sdk_path.join("cmdline-tools").join("latest").join("bin");
@@ -132,10 +144,10 @@ fn install_packages(sdk_path: &Path) -> Result<()> {
println!("Found sdkmanager at: {}", sdkmanager.display());
- run_sdkmanager(&sdkmanager, sdk_path)
+ run_sdkmanager(&sdkmanager, sdk_path, proxy)
}
-fn run_sdkmanager(sdkmanager: &Path, sdk_root: &Path) -> Result<()> {
+fn run_sdkmanager(sdkmanager: &Path, sdk_root: &Path, proxy: &ProxyConfig) -> Result<()> {
use std::process::{Command, Stdio};
use std::io::Write;
@@ -151,6 +163,13 @@ fn run_sdkmanager(sdkmanager: &Path, sdk_root: &Path) -> Result<()> {
Command::new(sdkmanager)
};
+ // Inject proxy env vars so sdkmanager picks them up
+ if let Some(proxy_url) = &proxy.url {
+ let url_str = proxy_url.as_str();
+ cmd.env("HTTPS_PROXY", url_str)
+ .env("HTTP_PROXY", url_str);
+ }
+
cmd.arg(format!("--sdk_root={}", sdk_root.display()))
.arg("--licenses")
.stdin(Stdio::piped())
@@ -192,6 +211,13 @@ fn run_sdkmanager(sdkmanager: &Path, sdk_root: &Path) -> Result<()> {
} else {
Command::new(sdkmanager)
};
+
+ // Inject proxy env vars here too
+ if let Some(proxy_url) = &proxy.url {
+ let url_str = proxy_url.as_str();
+ cmd.env("HTTPS_PROXY", url_str)
+ .env("HTTP_PROXY", url_str);
+ }
let status = cmd
.arg(format!("--sdk_root={}", sdk_root.display()))
diff --git i/src/sdk/ftc.rs w/src/sdk/ftc.rs
index 778cece..3e982e8 100644
--- i/src/sdk/ftc.rs
+++ w/src/sdk/ftc.rs
@@ -4,10 +4,12 @@
use colored::*;
use std::fs;
+use super::proxy::ProxyConfig;
+
const FTC_SDK_URL: &str = "https://github.com/FIRST-Tech-Challenge/FtcRobotController.git";
const FTC_SDK_VERSION: &str = "v10.1.1";
-pub fn install(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> {
+pub fn install(sdk_path: &Path, android_sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
if sdk_path.exists() {
println!("{} FTC SDK already installed at: {}",
"✓".green(),
@@ -22,8 +24,8 @@ pub fn install(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> {
println!("Cloning from: {}", FTC_SDK_URL);
println!("Version: {}", FTC_SDK_VERSION);
- // Clone the repository
- let repo = Repository::clone(FTC_SDK_URL, sdk_path)
+ // Clone the repository, with proxy if configured
+ let repo = clone_with_proxy(FTC_SDK_URL, sdk_path, proxy)
.context("Failed to clone FTC SDK")?;
// Checkout specific version
@@ -39,6 +41,44 @@ pub fn install(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> {
Ok(())
}
+/// Clone a git repo, injecting http.proxy into a git2 config if ProxyConfig has a URL.
+/// Returns a more helpful error message when a proxy was involved.
+fn clone_with_proxy(url: &str, dest: &Path, proxy: &ProxyConfig) -> Result<Repository> {
+ let mut opts = git2::CloneOptions::new();
+
+ if let Some(proxy_url) = &proxy.url {
+ // git2 reads http.proxy from a config object passed to the clone options.
+ // We build an in-memory config with just that one key.
+ let mut git_config = git2::Config::new()?;
+ git_config.set_str("http.proxy", proxy_url.as_str())?;
+ opts.local(false); // force network path even if URL looks local
+ // Unfortunately git2::CloneOptions doesn't have a direct .config() method,
+ // so we set the env var which libgit2 also respects as a fallback.
+ std::env::set_var("GIT_PROXY_COMMAND", ""); // clear any ssh proxy
+ std::env::set_var("HTTP_PROXY", proxy_url.as_str());
+ std::env::set_var("HTTPS_PROXY", proxy_url.as_str());
+ println!(" via proxy: {}", proxy_url);
+ }
+
+ Repository::clone_with(url, dest, &opts).map_err(|e| {
+ if proxy.url.is_some() {
+ anyhow::anyhow!(
+ "{}\n\n\
+ This failure may be caused by your proxy. If you are behind a \
+ corporate or school network, see 'weevil setup' for manual \
+ fallback instructions.",
+ e
+ )
+ } else {
+ anyhow::anyhow!(
+ "{}\n\n\
+ If you are behind a proxy, try: weevil sdk install --proxy <url>",
+ e
+ )
+ }
+ })
+}
+
fn create_local_properties(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> {
// Convert path to use forward slashes (works on both Windows and Unix)
let android_sdk_str = android_sdk_path
@@ -80,15 +120,39 @@ fn check_version(sdk_path: &Path) -> Result<()> {
Ok(())
}
-pub fn update(sdk_path: &Path) -> Result<()> {
+pub fn update(sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Updating FTC SDK...".bright_yellow());
+ // Set proxy env vars for the fetch if configured
+ if let Some(proxy_url) = &proxy.url {
+ std::env::set_var("HTTP_PROXY", proxy_url.as_str());
+ std::env::set_var("HTTPS_PROXY", proxy_url.as_str());
+ println!(" via proxy: {}", proxy_url);
+ }
+
let repo = Repository::open(sdk_path)
.context("FTC SDK not found or not a git repository")?;
// Fetch latest
let mut remote = repo.find_remote("origin")?;
- remote.fetch(&["refs/tags/*:refs/tags/*"], None, None)?;
+ remote.fetch(&["refs/tags/*:refs/tags/*"], None, None)
+ .map_err(|e| {
+ if proxy.url.is_some() {
+ anyhow::anyhow!(
+ "Failed to fetch: {}\n\n\
+ This failure may be caused by your proxy. If you are behind a \
+ corporate or school network, see 'weevil setup' for manual \
+ fallback instructions.",
+ e
+ )
+ } else {
+ anyhow::anyhow!(
+ "Failed to fetch: {}\n\n\
+ If you are behind a proxy, try: weevil sdk update --proxy <url>",
+ e
+ )
+ }
+ })?;
// Checkout latest version
let obj = repo.revparse_single(FTC_SDK_VERSION)?;
diff --git i/src/sdk/mod.rs w/src/sdk/mod.rs
index 080ce36..5d7c065 100644
--- i/src/sdk/mod.rs
+++ w/src/sdk/mod.rs
@@ -6,6 +6,7 @@
pub mod android;
pub mod ftc;
pub mod gradle;
+pub mod proxy;
pub struct SdkConfig {
pub ftc_sdk_path: PathBuf,

View File

@@ -3,13 +3,17 @@ use std::path::PathBuf;
use colored::*; use colored::*;
use crate::sdk::SdkConfig; use crate::sdk::SdkConfig;
use crate::sdk::proxy::ProxyConfig;
use crate::project::ProjectBuilder; use crate::project::ProjectBuilder;
pub fn create_project( pub fn create_project(
name: &str, name: &str,
ftc_sdk: Option<&str>, ftc_sdk: Option<&str>,
android_sdk: Option<&str>, android_sdk: Option<&str>,
_proxy: &ProxyConfig,
) -> Result<()> { ) -> Result<()> {
// _proxy is threaded through here so future flows (e.g. auto-install on
// missing SDK) can use it without changing the call site in main.
// Validate project name // Validate project name
if name.is_empty() { if name.is_empty() {
bail!("Project name cannot be empty"); bail!("Project name cannot be empty");

View File

@@ -1,18 +1,19 @@
use anyhow::Result; use anyhow::Result;
use colored::*; use colored::*;
use crate::sdk::SdkConfig; use crate::sdk::SdkConfig;
use crate::sdk::proxy::ProxyConfig;
pub fn install_sdks() -> Result<()> { pub fn install_sdks(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Installing SDKs...".bright_yellow().bold()); println!("{}", "Installing SDKs...".bright_yellow().bold());
println!(); println!();
let config = SdkConfig::new()?; let config = SdkConfig::new()?;
// Install FTC SDK // Install FTC SDK
crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path)?; crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path, proxy)?;
// Install Android SDK // Install Android SDK
crate::sdk::android::install(&config.android_sdk_path)?; crate::sdk::android::install(&config.android_sdk_path, proxy)?;
println!(); println!();
println!("{} All SDKs installed successfully", "".green().bold()); println!("{} All SDKs installed successfully", "".green().bold());
@@ -44,14 +45,14 @@ pub fn show_status() -> Result<()> {
Ok(()) Ok(())
} }
pub fn update_sdks() -> Result<()> { pub fn update_sdks(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Updating SDKs...".bright_yellow().bold()); println!("{}", "Updating SDKs...".bright_yellow().bold());
println!(); println!();
let config = SdkConfig::new()?; let config = SdkConfig::new()?;
// Update FTC SDK // Update FTC SDK
crate::sdk::ftc::update(&config.ftc_sdk_path)?; crate::sdk::ftc::update(&config.ftc_sdk_path, proxy)?;
println!(); println!();
println!("{} SDKs updated successfully", "".green().bold()); println!("{} SDKs updated successfully", "".green().bold());

View File

@@ -4,18 +4,19 @@ use std::process::Command;
use colored::*; use colored::*;
use crate::sdk::SdkConfig; use crate::sdk::SdkConfig;
use crate::sdk::proxy::ProxyConfig;
use crate::project::ProjectConfig; use crate::project::ProjectConfig;
/// Setup development environment - either system-wide or for a specific project /// Setup development environment - either system-wide or for a specific project
pub fn setup_environment(project_path: Option<&str>) -> Result<()> { pub fn setup_environment(project_path: Option<&str>, proxy: &ProxyConfig) -> Result<()> {
match project_path { match project_path {
Some(path) => setup_project(path), Some(path) => setup_project(path, proxy),
None => setup_system(), None => setup_system(proxy),
} }
} }
/// Setup system-wide development environment with default SDKs /// Setup system-wide development environment with default SDKs
fn setup_system() -> Result<()> { fn setup_system(proxy: &ProxyConfig) -> Result<()> {
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan()); println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
println!("{}", " System Setup - Preparing FTC Development Environment".bright_cyan().bold()); println!("{}", " System Setup - Preparing FTC Development Environment".bright_cyan().bold());
println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan()); println!("{}", "═══════════════════════════════════════════════════════════".bright_cyan());
@@ -57,7 +58,7 @@ fn setup_system() -> Result<()> {
} }
Err(_) => { Err(_) => {
println!("{} FTC SDK found but incomplete, reinstalling...", "".yellow()); println!("{} FTC SDK found but incomplete, reinstalling...", "".yellow());
crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path)?; crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path, proxy)?;
let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path) let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
.unwrap_or_else(|_| "unknown".to_string()); .unwrap_or_else(|_| "unknown".to_string());
installed.push(format!("FTC SDK {} (installed)", version)); installed.push(format!("FTC SDK {} (installed)", version));
@@ -65,7 +66,7 @@ fn setup_system() -> Result<()> {
} }
} else { } else {
println!("FTC SDK not found. Installing..."); println!("FTC SDK not found. Installing...");
crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path)?; crate::sdk::ftc::install(&sdk_config.ftc_sdk_path, &sdk_config.android_sdk_path, proxy)?;
let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path) let version = crate::sdk::ftc::get_version(&sdk_config.ftc_sdk_path)
.unwrap_or_else(|_| "unknown".to_string()); .unwrap_or_else(|_| "unknown".to_string());
installed.push(format!("FTC SDK {} (installed)", version)); installed.push(format!("FTC SDK {} (installed)", version));
@@ -85,13 +86,13 @@ fn setup_system() -> Result<()> {
} }
Err(_) => { Err(_) => {
println!("{} Android SDK found but incomplete, reinstalling...", "".yellow()); println!("{} Android SDK found but incomplete, reinstalling...", "".yellow());
crate::sdk::android::install(&sdk_config.android_sdk_path)?; crate::sdk::android::install(&sdk_config.android_sdk_path, proxy)?;
installed.push("Android SDK (installed)".to_string()); installed.push("Android SDK (installed)".to_string());
} }
} }
} else { } else {
println!("Android SDK not found. Installing..."); println!("Android SDK not found. Installing...");
crate::sdk::android::install(&sdk_config.android_sdk_path)?; crate::sdk::android::install(&sdk_config.android_sdk_path, proxy)?;
installed.push("Android SDK (installed)".to_string()); installed.push("Android SDK (installed)".to_string());
} }
println!(); println!();
@@ -132,7 +133,7 @@ fn setup_system() -> Result<()> {
} }
/// Setup dependencies for a specific project by reading its .weevil.toml /// Setup dependencies for a specific project by reading its .weevil.toml
fn setup_project(project_path: &str) -> Result<()> { fn setup_project(project_path: &str, proxy: &ProxyConfig) -> Result<()> {
let project_path = PathBuf::from(project_path); let project_path = PathBuf::from(project_path);
if !project_path.exists() { if !project_path.exists() {
@@ -214,7 +215,7 @@ fn setup_project(project_path: &str) -> Result<()> {
// Try to install it automatically // Try to install it automatically
println!("{}", "Attempting automatic installation...".bright_yellow()); println!("{}", "Attempting automatic installation...".bright_yellow());
match crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path) { match crate::sdk::ftc::install(&config.ftc_sdk_path, &config.android_sdk_path, proxy) {
Ok(_) => { Ok(_) => {
println!("{} FTC SDK {} installed successfully", println!("{} FTC SDK {} installed successfully",
"".green(), "".green(),
@@ -249,13 +250,13 @@ fn setup_project(project_path: &str) -> Result<()> {
} }
Err(_) => { Err(_) => {
println!("{} Android SDK found but incomplete, reinstalling...", "".yellow()); println!("{} Android SDK found but incomplete, reinstalling...", "".yellow());
crate::sdk::android::install(&config.android_sdk_path)?; crate::sdk::android::install(&config.android_sdk_path, proxy)?;
installed.push("Android SDK (installed)".to_string()); installed.push("Android SDK (installed)".to_string());
} }
} }
} else { } else {
println!("Android SDK not found. Installing..."); println!("Android SDK not found. Installing...");
crate::sdk::android::install(&config.android_sdk_path)?; crate::sdk::android::install(&config.android_sdk_path, proxy)?;
installed.push("Android SDK (installed)".to_string()); installed.push("Android SDK (installed)".to_string());
} }
println!(); println!();

View File

@@ -52,6 +52,19 @@ pub fn upgrade_project(path: &str) -> Result<()> {
"gradle/wrapper/gradle-wrapper.properties", "gradle/wrapper/gradle-wrapper.properties",
"gradle/wrapper/gradle-wrapper.jar", "gradle/wrapper/gradle-wrapper.jar",
".gitignore", ".gitignore",
// Android Studio integration — regenerated so run configs stay in
// sync if deploy.sh flags or script names ever change.
".idea/workspace.xml",
".idea/runConfigurations/Build.xml",
".idea/runConfigurations/Build (Windows).xml",
".idea/runConfigurations/Deploy (auto).xml",
".idea/runConfigurations/Deploy (auto) (Windows).xml",
".idea/runConfigurations/Deploy (USB).xml",
".idea/runConfigurations/Deploy (USB) (Windows).xml",
".idea/runConfigurations/Deploy (WiFi).xml",
".idea/runConfigurations/Deploy (WiFi) (Windows).xml",
".idea/runConfigurations/Test.xml",
".idea/runConfigurations/Test (Windows).xml",
]; ];
println!("{}", "Updating infrastructure files...".bright_yellow()); println!("{}", "Updating infrastructure files...".bright_yellow());

View File

@@ -3,11 +3,19 @@ use colored::*;
use anyhow::Result; use anyhow::Result;
use weevil::version::WEEVIL_VERSION; use weevil::version::WEEVIL_VERSION;
// Import ProxyConfig through our own `mod sdk`, not through the `weevil`
// library crate. Both re-export the same source, but Rust treats
// `weevil::sdk::proxy::ProxyConfig` and `sdk::proxy::ProxyConfig` as
// distinct types when a binary and its lib are compiled together.
// The command modules already see the local-mod version, so main must match.
mod commands; mod commands;
mod sdk; mod sdk;
mod project; mod project;
mod templates; mod templates;
use sdk::proxy::ProxyConfig;
#[derive(Parser)] #[derive(Parser)]
#[command(name = "weevil")] #[command(name = "weevil")]
#[command(author = "Eric Ratliff <eric@nxlearn.net>")] #[command(author = "Eric Ratliff <eric@nxlearn.net>")]
@@ -17,6 +25,14 @@ mod templates;
long_about = None long_about = None
)] )]
struct Cli { struct Cli {
/// Use this HTTP/HTTPS proxy for all downloads
#[arg(long, value_name = "URL", global = true)]
proxy: Option<String>,
/// Skip proxy entirely — go direct even if HTTPS_PROXY is set
#[arg(long, global = true)]
no_proxy: bool,
#[command(subcommand)] #[command(subcommand)]
command: Commands, command: Commands,
} }
@@ -119,15 +135,18 @@ fn main() -> Result<()> {
print_banner(); print_banner();
// Resolve proxy once at the top — every network-touching command uses it.
let proxy = ProxyConfig::resolve(cli.proxy.as_deref(), cli.no_proxy)?;
match cli.command { match cli.command {
Commands::New { name, ftc_sdk, android_sdk } => { Commands::New { name, ftc_sdk, android_sdk } => {
commands::new::create_project(&name, ftc_sdk.as_deref(), android_sdk.as_deref()) commands::new::create_project(&name, ftc_sdk.as_deref(), android_sdk.as_deref(), &proxy)
} }
Commands::Doctor => { Commands::Doctor => {
commands::doctor::run_diagnostics() commands::doctor::run_diagnostics()
} }
Commands::Setup { path } => { Commands::Setup { path } => {
commands::setup::setup_environment(path.as_deref()) commands::setup::setup_environment(path.as_deref(), &proxy)
} }
Commands::Uninstall { dry_run, only } => { Commands::Uninstall { dry_run, only } => {
commands::uninstall::uninstall_dependencies(dry_run, only) commands::uninstall::uninstall_dependencies(dry_run, only)
@@ -139,9 +158,9 @@ fn main() -> Result<()> {
commands::deploy::deploy_project(&path, usb, wifi, ip.as_deref()) commands::deploy::deploy_project(&path, usb, wifi, ip.as_deref())
} }
Commands::Sdk { command } => match command { Commands::Sdk { command } => match command {
SdkCommands::Install => commands::sdk::install_sdks(), SdkCommands::Install => commands::sdk::install_sdks(&proxy),
SdkCommands::Status => commands::sdk::show_status(), SdkCommands::Status => commands::sdk::show_status(),
SdkCommands::Update => commands::sdk::update_sdks(), SdkCommands::Update => commands::sdk::update_sdks(&proxy),
}, },
Commands::Config { path, set_sdk } => { Commands::Config { path, set_sdk } => {
if let Some(sdk_path) = set_sdk { if let Some(sdk_path) = set_sdk {

View File

@@ -55,6 +55,7 @@ impl ProjectBuilder {
"src/test/java/robot", "src/test/java/robot",
"src/test/java/robot/subsystems", "src/test/java/robot/subsystems",
"gradle/wrapper", "gradle/wrapper",
".idea/runConfigurations",
]; ];
for dir in dirs { for dir in dirs {
@@ -416,6 +417,304 @@ class BasicTest {
test_file test_file
)?; )?;
// Android Studio integration: .idea/ files
self.generate_idea_files(project_path)?;
Ok(())
}
/// Generate .idea/ files for Android Studio integration.
///
/// The goal is for students to open the project in Android Studio and see
/// a clean file tree (just src/ and the scripts) with Run configurations
/// that invoke Weevil's shell scripts directly. All the internal plumbing
/// (sdk/, .gradle/, build/) is hidden from the IDE view.
///
/// Android Studio uses IntelliJ's run configuration XML format. The
/// ShellScript type invokes a script relative to the project root — exactly
/// what we want since deploy.sh and build.sh already live there.
fn generate_idea_files(&self, project_path: &Path) -> Result<()> {
// workspace.xml — controls the file-tree view and hides internals.
// We use a ProjectViewPane exclude pattern list rather than touching
// the module's source roots, so this works regardless of whether the
// student has opened the project before.
let workspace_xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectViewManager">
<state>
<navigator currentProjector="ProjectFiles" hideEmptyMiddlePackages="true" sortByType="true">
<state>
<expand>
<file url="file://$PROJECT_DIR$/src" />
<file url="file://$PROJECT_DIR$/src/main" />
<file url="file://$PROJECT_DIR$/src/main/java" />
<file url="file://$PROJECT_DIR$/src/main/java/robot" />
<file url="file://$PROJECT_DIR$/src/test" />
<file url="file://$PROJECT_DIR$/src/test/java" />
<file url="file://$PROJECT_DIR$/src/test/java/robot" />
</expand>
</state>
</navigator>
</state>
</component>
<component name="ExcludedFiles">
<file url="file://$PROJECT_DIR$/build" reason="Build output" />
<file url="file://$PROJECT_DIR$/.gradle" reason="Gradle cache" />
<file url="file://$PROJECT_DIR$/gradle" reason="Gradle wrapper internals" />
</component>
</project>
"#;
fs::write(project_path.join(".idea/workspace.xml"), workspace_xml)?;
// Run configurations. Each is a ShellScript type that invokes one of
// Weevil's scripts. Android Studio shows these in the Run dropdown
// at the top of the IDE — no configuration needed by the student.
//
// We generate both Unix (.sh, ./gradlew) and Windows (.bat, gradlew.bat)
// variants. Android Studio automatically hides configs whose script files
// don't exist, so only the platform-appropriate ones appear in the dropdown.
// Build (Unix) — just builds the APK without deploying
let build_unix_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Build" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/build.sh" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/bash" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Build.xml"),
build_unix_xml,
)?;
// Build (Windows) — same, but calls build.bat
let build_windows_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Build (Windows)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/build.bat" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="cmd.exe" />
<option name="INTERPRETER_OPTIONS" value="/c" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Build (Windows).xml"),
build_windows_xml,
)?;
// Deploy (auto) — no flags, deploy.sh auto-detects USB vs WiFi
let deploy_auto_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (auto)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.sh" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/bash" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (auto).xml"),
deploy_auto_xml,
)?;
// Deploy (auto) (Windows)
let deploy_auto_windows_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (auto) (Windows)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.bat" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="cmd.exe" />
<option name="INTERPRETER_OPTIONS" value="/c" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (auto) (Windows).xml"),
deploy_auto_windows_xml,
)?;
// Deploy (USB) — forces USB connection
let deploy_usb_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (USB)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.sh" />
<option name="SCRIPT_OPTIONS" value="--usb" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/bash" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (USB).xml"),
deploy_usb_xml,
)?;
// Deploy (USB) (Windows)
let deploy_usb_windows_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (USB) (Windows)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.bat" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="cmd.exe" />
<option name="INTERPRETER_OPTIONS" value="/c" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (USB) (Windows).xml"),
deploy_usb_windows_xml,
)?;
// Deploy (WiFi) — forces WiFi connection to default 192.168.43.1
let deploy_wifi_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (WiFi)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.sh" />
<option name="SCRIPT_OPTIONS" value="--wifi" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/bash" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (WiFi).xml"),
deploy_wifi_xml,
)?;
// Deploy (WiFi) (Windows)
let deploy_wifi_windows_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Deploy (WiFi) (Windows)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/deploy.bat" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="cmd.exe" />
<option name="INTERPRETER_OPTIONS" value="/c" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Deploy (WiFi) (Windows).xml"),
deploy_wifi_windows_xml,
)?;
// Test — runs the unit test suite via Gradle
let test_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Test" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/gradlew" />
<option name="SCRIPT_OPTIONS" value="test" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/bash" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Test.xml"),
test_xml,
)?;
// Test (Windows)
let test_windows_xml = r#"<component name="ProjectRunConfigurationManager">
<configuration name="Test (Windows)" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="$PROJECT_DIR$/gradlew.bat" />
<option name="SCRIPT_OPTIONS" value="test" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="cmd.exe" />
<option name="INTERPRETER_OPTIONS" value="/c" />
<option name="EXECUTE_IN_TERMINAL" value="true" />
<option name="EXECUTE_SCRIPT_FILE" value="true" />
<envs />
<method v="2" />
</configuration>
</component>
"#;
fs::write(
project_path.join(".idea/runConfigurations/Test (Windows).xml"),
test_windows_xml,
)?;
Ok(()) Ok(())
} }

View File

@@ -1,16 +1,17 @@
use std::path::Path; use std::path::Path;
use anyhow::{Result, Context}; use anyhow::{Result, Context};
use indicatif::{ProgressBar, ProgressStyle}; use indicatif::{ProgressBar, ProgressStyle};
use reqwest::blocking::Client;
use std::fs::File; use std::fs::File;
use std::io::Write; use std::io::Write;
use colored::*; use colored::*;
use super::proxy::ProxyConfig;
const ANDROID_SDK_URL_LINUX: &str = "https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip"; const ANDROID_SDK_URL_LINUX: &str = "https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip";
const ANDROID_SDK_URL_MAC: &str = "https://dl.google.com/android/repository/commandlinetools-mac-11076708_latest.zip"; const ANDROID_SDK_URL_MAC: &str = "https://dl.google.com/android/repository/commandlinetools-mac-11076708_latest.zip";
const ANDROID_SDK_URL_WINDOWS: &str = "https://dl.google.com/android/repository/commandlinetools-win-11076708_latest.zip"; const ANDROID_SDK_URL_WINDOWS: &str = "https://dl.google.com/android/repository/commandlinetools-win-11076708_latest.zip";
pub fn install(sdk_path: &Path) -> Result<()> { pub fn install(sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
// Check if SDK exists AND is complete // Check if SDK exists AND is complete
if sdk_path.exists() { if sdk_path.exists() {
match verify(sdk_path) { match verify(sdk_path) {
@@ -42,10 +43,14 @@ pub fn install(sdk_path: &Path) -> Result<()> {
// Download // Download
println!("Downloading from: {}", url); println!("Downloading from: {}", url);
let client = Client::new(); proxy.print_status();
let client = proxy.client()?;
let response = client.get(url) let response = client.get(url)
.send() .send()
.context("Failed to download Android SDK")?; .map_err(|e| {
super::proxy::print_offline_instructions();
anyhow::anyhow!("Failed to download Android SDK: {}", e)
})?;
let total_size = response.content_length().unwrap_or(0); let total_size = response.content_length().unwrap_or(0);

View File

@@ -4,10 +4,12 @@ use git2::Repository;
use colored::*; use colored::*;
use std::fs; use std::fs;
use super::proxy::{ProxyConfig, GitProxyGuard};
const FTC_SDK_URL: &str = "https://github.com/FIRST-Tech-Challenge/FtcRobotController.git"; const FTC_SDK_URL: &str = "https://github.com/FIRST-Tech-Challenge/FtcRobotController.git";
const FTC_SDK_VERSION: &str = "v10.1.1"; const FTC_SDK_VERSION: &str = "v10.1.1";
pub fn install(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> { pub fn install(sdk_path: &Path, android_sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
if sdk_path.exists() { if sdk_path.exists() {
println!("{} FTC SDK already installed at: {}", println!("{} FTC SDK already installed at: {}",
"".green(), "".green(),
@@ -21,10 +23,18 @@ pub fn install(sdk_path: &Path, android_sdk_path: &Path) -> Result<()> {
println!("{}", "Installing FTC SDK...".bright_yellow()); println!("{}", "Installing FTC SDK...".bright_yellow());
println!("Cloning from: {}", FTC_SDK_URL); println!("Cloning from: {}", FTC_SDK_URL);
println!("Version: {}", FTC_SDK_VERSION); println!("Version: {}", FTC_SDK_VERSION);
proxy.print_status();
// GitProxyGuard sets HTTPS_PROXY for the duration of the clone so that
// libgit2 honours --proxy / --no-proxy without touching ~/.gitconfig.
let _guard = GitProxyGuard::new(proxy);
// Clone the repository // Clone the repository
let repo = Repository::clone(FTC_SDK_URL, sdk_path) let repo = Repository::clone(FTC_SDK_URL, sdk_path)
.context("Failed to clone FTC SDK")?; .map_err(|e| {
super::proxy::print_offline_instructions();
anyhow::anyhow!("Failed to clone FTC SDK: {}", e)
})?;
// Checkout specific version // Checkout specific version
let obj = repo.revparse_single(FTC_SDK_VERSION)?; let obj = repo.revparse_single(FTC_SDK_VERSION)?;
@@ -80,15 +90,23 @@ fn check_version(sdk_path: &Path) -> Result<()> {
Ok(()) Ok(())
} }
pub fn update(sdk_path: &Path) -> Result<()> { pub fn update(sdk_path: &Path, proxy: &ProxyConfig) -> Result<()> {
println!("{}", "Updating FTC SDK...".bright_yellow()); println!("{}", "Updating FTC SDK...".bright_yellow());
proxy.print_status();
let repo = Repository::open(sdk_path) let repo = Repository::open(sdk_path)
.context("FTC SDK not found or not a git repository")?; .context("FTC SDK not found or not a git repository")?;
// Guard env vars for the fetch
let _guard = GitProxyGuard::new(proxy);
// Fetch latest // Fetch latest
let mut remote = repo.find_remote("origin")?; let mut remote = repo.find_remote("origin")?;
remote.fetch(&["refs/tags/*:refs/tags/*"], None, None)?; remote.fetch(&["refs/tags/*:refs/tags/*"], None, None)
.map_err(|e| {
super::proxy::print_offline_instructions();
anyhow::anyhow!("Failed to fetch FTC SDK updates: {}", e)
})?;
// Checkout latest version // Checkout latest version
let obj = repo.revparse_single(FTC_SDK_VERSION)?; let obj = repo.revparse_single(FTC_SDK_VERSION)?;

View File

@@ -6,6 +6,7 @@ use colored::*;
pub mod android; pub mod android;
pub mod ftc; pub mod ftc;
pub mod gradle; pub mod gradle;
pub mod proxy;
pub struct SdkConfig { pub struct SdkConfig {
pub ftc_sdk_path: PathBuf, pub ftc_sdk_path: PathBuf,

322
src/sdk/proxy.rs Normal file
View File

@@ -0,0 +1,322 @@
use colored::*;
use reqwest::blocking;
use reqwest::Url;
/// Where the proxy URL came from — used for status messages.
#[derive(Debug, Clone, PartialEq)]
pub enum ProxySource {
/// --proxy <url> on the command line
Flag,
/// HTTPS_PROXY or HTTP_PROXY environment variable
Env(String),
}
/// Resolved proxy configuration. A `None` url means "go direct".
#[derive(Debug, Clone)]
pub struct ProxyConfig {
pub url: Option<Url>,
pub source: Option<ProxySource>,
}
impl ProxyConfig {
/// Resolve proxy with this priority:
/// 1. --no-proxy → direct, ignore everything
/// 2. --proxy <url> → use that URL
/// 3. HTTPS_PROXY / HTTP_PROXY env vars
/// 4. Nothing → direct
pub fn resolve(proxy_flag: Option<&str>, no_proxy: bool) -> Result<Self, anyhow::Error> {
if no_proxy {
return Ok(Self { url: None, source: None });
}
if let Some(raw) = proxy_flag {
let url = Url::parse(raw)
.map_err(|e| anyhow::anyhow!("Invalid --proxy URL '{}': {}", raw, e))?;
return Ok(Self { url: Some(url), source: Some(ProxySource::Flag) });
}
// Walk the env vars in priority order
for var in &["HTTPS_PROXY", "https_proxy", "HTTP_PROXY", "http_proxy"] {
if let Ok(val) = std::env::var(var) {
if val.is_empty() { continue; }
let url = Url::parse(&val)
.map_err(|e| anyhow::anyhow!("Invalid {} env var '{}': {}", var, val, e))?;
return Ok(Self {
url: Some(url),
source: Some(ProxySource::Env(var.to_string())),
});
}
}
Ok(Self { url: None, source: None })
}
/// True when the user explicitly passed --proxy (as opposed to env-var pickup).
/// Used for distinguishing "you asked for this proxy and it failed" from
/// "we picked up an ambient proxy from your environment" in error paths.
#[allow(dead_code)]
pub fn is_explicit(&self) -> bool {
matches!(self.source, Some(ProxySource::Flag))
}
/// Human-readable description of where the proxy came from, for status output.
pub fn source_description(&self) -> String {
match &self.source {
Some(ProxySource::Flag) => "--proxy flag".to_string(),
Some(ProxySource::Env(var)) => format!("{} env var", var),
None => "none".to_string(),
}
}
/// Print a one-line proxy status line (used in setup output).
pub fn print_status(&self) {
match &self.url {
Some(url) => println!(
" {} Proxy: {} ({})",
"".green(),
url.as_str().bright_white(),
self.source_description()
),
None => println!(
" {} Proxy: direct (no proxy)",
"".bright_black()
),
}
}
/// Build a reqwest blocking Client that honours this proxy config.
///
/// * `Some(url)` → all HTTP/HTTPS traffic goes through that proxy.
/// * `None` → direct, no proxy at all.
///
/// We always go through the builder (never plain `Client::new()`) because
/// `Client::new()` silently picks up env-var proxies. When the user says
/// `--no-proxy` we need to actively disable that.
pub fn client(&self) -> anyhow::Result<blocking::Client> {
let mut builder = blocking::ClientBuilder::new();
match &self.url {
Some(url) => {
builder = builder.proxy(reqwest::Proxy::all(url.clone())?);
}
None => {
// Actively suppress env-var auto-detection.
builder = builder.no_proxy();
}
}
builder.build().map_err(|e| anyhow::anyhow!("Failed to build HTTP client: {}", e))
}
}
/// RAII guard that temporarily sets HTTPS_PROXY / HTTP_PROXY for the lifetime
/// of the guard, then restores the previous values on drop.
///
/// libgit2 (the C library behind the `git2` crate) reads these env vars
/// directly for its HTTP transport. This is the cleanest way to make
/// `git2::Repository::clone` and `remote.fetch()` honour a `--proxy` flag
/// without touching the user's global `~/.gitconfig`.
///
/// When the ProxyConfig has no URL (direct / --no-proxy) the guard *clears*
/// the vars so libgit2 won't accidentally pick up an ambient proxy the user
/// didn't intend for this operation.
pub struct GitProxyGuard {
prev_https: Option<String>,
prev_http: Option<String>,
}
impl GitProxyGuard {
pub fn new(config: &ProxyConfig) -> Self {
let prev_https = std::env::var("HTTPS_PROXY").ok();
let prev_http = std::env::var("HTTP_PROXY").ok();
match &config.url {
Some(url) => {
let s = url.as_str();
std::env::set_var("HTTPS_PROXY", s);
std::env::set_var("HTTP_PROXY", s);
}
None => {
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("HTTP_PROXY");
}
}
Self { prev_https, prev_http }
}
}
impl Drop for GitProxyGuard {
fn drop(&mut self) {
match &self.prev_https {
Some(v) => std::env::set_var("HTTPS_PROXY", v),
None => std::env::remove_var("HTTPS_PROXY"),
}
match &self.prev_http {
Some(v) => std::env::set_var("HTTP_PROXY", v),
None => std::env::remove_var("HTTP_PROXY"),
}
}
}
/// Print clear, actionable instructions for obtaining dependencies without
/// an internet connection. Called whenever a network download fails so the
/// user always sees their escape hatch.
pub fn print_offline_instructions() {
println!();
println!("{}", "── Offline / Air-Gapped Installation ──────────────────────".bright_yellow().bold());
println!();
println!("If you have no internet access (or the proxy is not working),");
println!("you can obtain the required SDKs on a connected machine and");
println!("copy them over.");
println!();
println!("{}", "1. FTC SDK (git clone)".bright_cyan().bold());
println!(" On a connected machine:");
println!(" git clone https://github.com/FIRST-Tech-Challenge/FtcRobotController.git");
println!(" cd FtcRobotController");
println!(" git checkout v10.1.1");
println!();
println!(" Copy the entire FtcRobotController/ directory to this machine");
println!(" at ~/.weevil/ftc-sdk/ (or wherever your .weevil.toml points).");
println!();
println!("{}", "2. Android SDK (command-line tools)".bright_cyan().bold());
println!(" Download the zip for your OS from a connected machine:");
println!(" Linux: https://dl.google.com/android/repository/commandlinetools-linux-11076708_latest.zip");
println!(" macOS: https://dl.google.com/android/repository/commandlinetools-mac-11076708_latest.zip");
println!(" Windows: https://dl.google.com/android/repository/commandlinetools-win-11076708_latest.zip");
println!();
println!(" Extract to ~/.weevil/android-sdk/, then run sdkmanager:");
println!(" ./cmdline-tools/latest/bin/sdkmanager \\");
println!(" platform-tools platforms;android-34 build-tools;34.0.0");
println!();
println!(" Copy the resulting android-sdk/ directory to this machine.");
println!();
println!("{}", "3. Gradle distribution".bright_cyan().bold());
println!(" Gradle fetches its own distribution the first time ./gradlew");
println!(" runs. If that fails offline, download manually:");
println!(" https://services.gradle.org/distributions/gradle-8.9-bin.zip");
println!(" Extract into ~/.gradle/wrapper/dists/gradle-8.9-bin/");
println!(" (the exact subdirectory is printed by gradlew on failure).");
println!();
println!("{}", "4. Proxy quick reference".bright_cyan().bold());
println!(" • Use a specific proxy: weevil --proxy http://proxy:3128 sdk install");
println!(" • Skip the proxy entirely: weevil --no-proxy sdk install");
println!(" • Gradle also reads HTTPS_PROXY / HTTP_PROXY, so set those");
println!(" in your shell before running ./gradlew if the build needs a proxy.");
println!();
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::Mutex;
// Env vars are process-global. cargo test runs tests in parallel within
// a single binary, so any test that sets/removes HTTPS_PROXY or HTTP_PROXY
// must hold this lock for its entire duration.
static ENV_MUTEX: Mutex<()> = Mutex::new(());
#[test]
fn no_proxy_flag_forces_direct() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::set_var("HTTPS_PROXY", "http://proxy.example.com:3128");
let config = ProxyConfig::resolve(None, true).unwrap();
assert!(config.url.is_none());
std::env::remove_var("HTTPS_PROXY");
}
#[test]
fn explicit_flag_overrides_env() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::set_var("HTTPS_PROXY", "http://env-proxy.example.com:3128");
let config = ProxyConfig::resolve(Some("http://flag-proxy.example.com:8080"), false).unwrap();
assert_eq!(config.url.as_ref().unwrap().host_str(), Some("flag-proxy.example.com"));
assert!(config.is_explicit());
std::env::remove_var("HTTPS_PROXY");
}
#[test]
fn picks_up_env_var() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("https_proxy");
std::env::set_var("HTTP_PROXY", "http://env-proxy.example.com:3128");
let config = ProxyConfig::resolve(None, false).unwrap();
assert_eq!(config.url.as_ref().unwrap().host_str(), Some("env-proxy.example.com"));
assert_eq!(config.source, Some(ProxySource::Env("HTTP_PROXY".to_string())));
std::env::remove_var("HTTP_PROXY");
}
#[test]
fn direct_when_nothing_set() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("https_proxy");
std::env::remove_var("HTTP_PROXY");
std::env::remove_var("http_proxy");
let config = ProxyConfig::resolve(None, false).unwrap();
assert!(config.url.is_none());
}
#[test]
fn rejects_garbage_url() {
let result = ProxyConfig::resolve(Some("not a url at all"), false);
assert!(result.is_err());
}
#[test]
fn client_builds_with_proxy() {
let config = ProxyConfig::resolve(Some("http://proxy.example.com:3128"), false).unwrap();
assert!(config.client().is_ok());
}
#[test]
fn client_builds_direct() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("https_proxy");
std::env::remove_var("HTTP_PROXY");
std::env::remove_var("http_proxy");
let config = ProxyConfig::resolve(None, true).unwrap();
assert!(config.client().is_ok());
}
#[test]
fn git_proxy_guard_sets_and_restores() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::set_var("HTTPS_PROXY", "http://original:1111");
std::env::set_var("HTTP_PROXY", "http://original:2222");
let config = ProxyConfig::resolve(Some("http://guarded:9999"), false).unwrap();
{
let _guard = GitProxyGuard::new(&config);
// Url::parse normalises — trailing slash is expected
assert_eq!(std::env::var("HTTPS_PROXY").unwrap(), "http://guarded:9999/");
assert_eq!(std::env::var("HTTP_PROXY").unwrap(), "http://guarded:9999/");
}
assert_eq!(std::env::var("HTTPS_PROXY").unwrap(), "http://original:1111");
assert_eq!(std::env::var("HTTP_PROXY").unwrap(), "http://original:2222");
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("HTTP_PROXY");
}
#[test]
fn git_proxy_guard_clears_for_direct() {
let _env_lock = ENV_MUTEX.lock().unwrap();
std::env::set_var("HTTPS_PROXY", "http://should-be-cleared:1111");
std::env::set_var("HTTP_PROXY", "http://should-be-cleared:2222");
let config = ProxyConfig { url: None, source: None };
{
let _guard = GitProxyGuard::new(&config);
assert!(std::env::var("HTTPS_PROXY").is_err());
assert!(std::env::var("HTTP_PROXY").is_err());
}
assert_eq!(std::env::var("HTTPS_PROXY").unwrap(), "http://should-be-cleared:1111");
assert_eq!(std::env::var("HTTP_PROXY").unwrap(), "http://should-be-cleared:2222");
std::env::remove_var("HTTPS_PROXY");
std::env::remove_var("HTTP_PROXY");
}
}

View File

@@ -1,3 +1,3 @@
// Intentionally hardcoded. When you bump the version in Cargo.toml, // Intentionally hardcoded. When you bump the version in Cargo.toml,
// tests will fail here until you update this to match. // tests will fail here until you update this to match.
pub const EXPECTED_VERSION: &str = "1.1.0-beta.1"; pub const EXPECTED_VERSION: &str = "1.1.0-beta.2";

390
tests/proxy_integration.rs Normal file
View File

@@ -0,0 +1,390 @@
//! Integration tests for proxy support.
//!
//! Architecture per test:
//!
//! weevil (or ProxyConfig::client())
//! │ --proxy http://127.0.0.1:<proxy_port>
//! ▼
//! TestProxy ← real forwarding proxy, hyper HTTP/1.1 server
//! │ forwards absolute-form URI to origin
//! ▼
//! mockito origin ← fake dl.google.com / github.com, returns canned bytes
//!
//! This proves traffic actually traverses the proxy, not just that the download
//! works. The TestProxy struct is the only custom code; everything else is
//! standard mockito + assert_cmd.
use std::convert::Infallible;
use std::net::SocketAddr;
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Mutex;
// Tests that mutate HTTPS_PROXY / HTTP_PROXY must not run concurrently —
// those env vars are process-global. cargo test runs tests in parallel
// within a single binary by default, so we serialize access with this lock.
// Tests that don't touch env vars (or that only use --proxy flag) skip it.
static ENV_MUTEX: Mutex<()> = Mutex::new(());
use hyper::body::Bytes;
use hyper::server::conn::http1;
use hyper::service::service_fn;
use hyper_util::client::legacy::Client;
use hyper_util::client::legacy::connect::HttpConnector;
use hyper_util::rt::{TokioExecutor, TokioIo};
use http_body_util::{BodyExt, Full};
use tokio::net::TcpListener;
use weevil::sdk::proxy::ProxyConfig;
// ---------------------------------------------------------------------------
// TestProxy — a minimal HTTP forward proxy for use in tests.
//
// Binds to 127.0.0.1:0 (OS picks the port), spawns a tokio task to serve
// connections, and shuts down when dropped. Also counts how many requests
// it forwarded so tests can assert the proxy was actually hit.
// ---------------------------------------------------------------------------
/// A live forwarding proxy bound to a random local port.
struct TestProxy {
addr: SocketAddr,
request_count: Arc<AtomicU64>,
/// Dropping this handle shuts the server down.
_shutdown: tokio::sync::mpsc::Sender<()>,
}
/// The actual proxy handler, extracted to a named async fn.
///
/// You cannot put a return-type annotation on an `async move { }` block, and
/// you cannot use `-> impl Future` on a closure inside `service_fn` because
/// the opaque future type is unnameable. A named `async fn` is the one place
/// Rust lets you write both `async` and an explicit return type in the same
/// spot — the compiler knows the concrete future type and can verify the
/// `Into<Box<dyn Error>>` bound that `serve_connection` requires.
async fn proxy_handler(
client: Client<HttpConnector, Full<Bytes>>,
counter: Arc<AtomicU64>,
req: hyper::Request<hyper::body::Incoming>,
) -> Result<hyper::Response<Full<Bytes>>, Infallible> {
counter.fetch_add(1, Ordering::Relaxed);
// The client sends the request in absolute-form:
// GET http://origin:PORT/path HTTP/1.1
// hyper parses that into req.uri() for us.
let uri = req.uri().clone();
// Collect the incoming body so we can forward it.
let body_bytes = req.into_body().collect().await
.map(|b| b.to_bytes())
.unwrap_or_default();
let forwarded = hyper::Request::builder()
.method("GET")
.uri(uri)
.body(Full::new(body_bytes))
.unwrap();
match client.request(forwarded).await {
Ok(upstream_resp) => {
// Collect the upstream body and re-wrap so we return a concrete
// body type (not Incoming).
let status = upstream_resp.status();
let headers = upstream_resp.headers().clone();
let collected = upstream_resp.into_body().collect().await
.map(|b| b.to_bytes())
.unwrap_or_default();
let mut resp = hyper::Response::builder()
.status(status)
.body(Full::new(collected))
.unwrap();
*resp.headers_mut() = headers;
Ok(resp)
}
Err(_) => Ok(
hyper::Response::builder()
.status(502)
.body(Full::new(Bytes::from("Bad Gateway")))
.unwrap()
),
}
}
impl TestProxy {
async fn start() -> Self {
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
let count = Arc::new(AtomicU64::new(0));
let count_clone = count.clone();
let (shutdown_tx, mut shutdown_rx) = tokio::sync::mpsc::channel::<()>(1);
let hyper_client: Client<HttpConnector, Full<Bytes>> =
Client::builder(TokioExecutor::new()).build_http();
tokio::spawn(async move {
loop {
let stream = tokio::select! {
Ok((stream, _peer)) = listener.accept() => stream,
_ = shutdown_rx.recv() => break,
else => break,
};
let client = hyper_client.clone();
let counter = count_clone.clone();
tokio::spawn(async move {
let io = TokioIo::new(stream);
// The closure just delegates to proxy_handler. The named
// fn's return type is visible to the compiler so it can
// resolve the Error associated type that serve_connection
// needs.
let _ = http1::Builder::new()
.serve_connection(io, service_fn(move |req| {
proxy_handler(client.clone(), counter.clone(), req)
}))
.await;
});
}
});
Self {
addr,
request_count: count,
_shutdown: shutdown_tx,
}
}
fn proxy_url(&self) -> String {
format!("http://{}", self.addr)
}
fn requests_forwarded(&self) -> u64 {
self.request_count.load(Ordering::Relaxed)
}
}
// ---------------------------------------------------------------------------
// Tests: ProxyConfig::client() talking through TestProxy to mockito.
//
// reqwest's blocking::Client owns an internal tokio Runtime. Dropping it
// inside an async context panics on tokio ≥ 1.49 ("Cannot drop a runtime in
// a context where blocking is not allowed"). Each test therefore does its
// reqwest work — client creation, HTTP calls, and drop — inside
// spawn_blocking, which runs on a thread-pool thread where blocking is fine.
// The mockito origin and TestProxy stay in the async body because they need
// the tokio runtime for their listeners.
// ---------------------------------------------------------------------------
#[tokio::test]
async fn proxy_forwards_request_to_origin() {
let mut origin = mockito::Server::new_async().await;
let _mock = origin
.mock("GET", "/sdk.zip")
.with_status(200)
.with_header("content-type", "application/octet-stream")
.with_body(b"fake-sdk-bytes".as_slice())
.create_async()
.await;
let proxy = TestProxy::start().await;
let proxy_url = proxy.proxy_url();
let origin_url = origin.url();
let (status, body) = tokio::task::spawn_blocking(move || {
let config = ProxyConfig::resolve(Some(&proxy_url), false).unwrap();
let client = config.client().unwrap();
let resp = client.get(format!("{}/sdk.zip", origin_url)).send().unwrap();
(resp.status().as_u16(), resp.text().unwrap())
}).await.unwrap();
assert_eq!(status, 200);
assert_eq!(body, "fake-sdk-bytes");
assert_eq!(proxy.requests_forwarded(), 1);
}
#[tokio::test]
async fn no_proxy_bypasses_proxy_entirely() {
let _env_lock = ENV_MUTEX.lock().unwrap();
let mut origin = mockito::Server::new_async().await;
let _mock = origin
.mock("GET", "/direct.txt")
.with_status(200)
.with_body("direct-hit")
.create_async()
.await;
let proxy = TestProxy::start().await;
let proxy_url = proxy.proxy_url();
let origin_url = origin.url();
let (status, body) = tokio::task::spawn_blocking(move || {
std::env::set_var("HTTPS_PROXY", &proxy_url);
let config = ProxyConfig::resolve(None, true).unwrap();
std::env::remove_var("HTTPS_PROXY");
let client = config.client().unwrap();
let resp = client.get(format!("{}/direct.txt", origin_url)).send().unwrap();
(resp.status().as_u16(), resp.text().unwrap())
}).await.unwrap();
assert_eq!(status, 200);
assert_eq!(body, "direct-hit");
assert_eq!(proxy.requests_forwarded(), 0);
}
#[tokio::test]
async fn env_var_proxy_is_picked_up() {
let _env_lock = ENV_MUTEX.lock().unwrap();
let mut origin = mockito::Server::new_async().await;
let _mock = origin
.mock("GET", "/env.txt")
.with_status(200)
.with_body("via-env-proxy")
.create_async()
.await;
let proxy = TestProxy::start().await;
let proxy_url = proxy.proxy_url();
let origin_url = origin.url();
let (status, body) = tokio::task::spawn_blocking(move || {
std::env::remove_var("HTTP_PROXY");
std::env::remove_var("http_proxy");
std::env::remove_var("https_proxy");
std::env::set_var("HTTPS_PROXY", &proxy_url);
let config = ProxyConfig::resolve(None, false).unwrap();
std::env::remove_var("HTTPS_PROXY");
let client = config.client().unwrap();
let resp = client.get(format!("{}/env.txt", origin_url)).send().unwrap();
(resp.status().as_u16(), resp.text().unwrap())
}).await.unwrap();
assert_eq!(status, 200);
assert_eq!(body, "via-env-proxy");
assert_eq!(proxy.requests_forwarded(), 1);
}
#[tokio::test]
async fn explicit_proxy_flag_overrides_env() {
let _env_lock = ENV_MUTEX.lock().unwrap();
let mut origin = mockito::Server::new_async().await;
let _mock = origin
.mock("GET", "/override.txt")
.with_status(200)
.with_body("flag-proxy-wins")
.create_async()
.await;
let decoy = TestProxy::start().await;
let real = TestProxy::start().await;
let decoy_url = decoy.proxy_url();
let real_url = real.proxy_url();
let origin_url = origin.url();
let (status, body) = tokio::task::spawn_blocking(move || {
std::env::set_var("HTTPS_PROXY", &decoy_url);
let config = ProxyConfig::resolve(Some(&real_url), false).unwrap();
std::env::remove_var("HTTPS_PROXY");
let client = config.client().unwrap();
let resp = client.get(format!("{}/override.txt", origin_url)).send().unwrap();
(resp.status().as_u16(), resp.text().unwrap())
}).await.unwrap();
assert_eq!(status, 200);
assert_eq!(body, "flag-proxy-wins");
assert_eq!(real.requests_forwarded(), 1);
assert_eq!(decoy.requests_forwarded(), 0);
}
#[tokio::test]
async fn proxy_returns_502_when_origin_is_unreachable() {
let proxy = TestProxy::start().await;
let proxy_url = proxy.proxy_url();
let status = tokio::task::spawn_blocking(move || {
let config = ProxyConfig::resolve(Some(&proxy_url), false).unwrap();
let client = config.client().unwrap();
let resp = client.get("http://127.0.0.1:1/unreachable").send().unwrap();
resp.status().as_u16()
}).await.unwrap();
assert_eq!(status, 502);
assert_eq!(proxy.requests_forwarded(), 1);
}
#[tokio::test]
async fn multiple_sequential_requests_all_forwarded() {
let mut origin = mockito::Server::new_async().await;
let _m1 = origin.mock("GET", "/a").with_status(200).with_body("aaa").create_async().await;
let _m2 = origin.mock("GET", "/b").with_status(200).with_body("bbb").create_async().await;
let _m3 = origin.mock("GET", "/c").with_status(200).with_body("ccc").create_async().await;
let proxy = TestProxy::start().await;
let proxy_url = proxy.proxy_url();
let origin_url = origin.url();
let (a, b, c) = tokio::task::spawn_blocking(move || {
let config = ProxyConfig::resolve(Some(&proxy_url), false).unwrap();
let client = config.client().unwrap();
let a = client.get(format!("{}/a", origin_url)).send().unwrap().text().unwrap();
let b = client.get(format!("{}/b", origin_url)).send().unwrap().text().unwrap();
let c = client.get(format!("{}/c", origin_url)).send().unwrap().text().unwrap();
(a, b, c)
}).await.unwrap();
assert_eq!(a, "aaa");
assert_eq!(b, "bbb");
assert_eq!(c, "ccc");
assert_eq!(proxy.requests_forwarded(), 3);
}
// ---------------------------------------------------------------------------
// CLI-level tests
// ---------------------------------------------------------------------------
#[allow(deprecated)] // cargo_bin_cmd! requires assert_cmd ≥ 2.2; we're on 2.1.2
#[test]
fn cli_help_shows_proxy_flags() {
let mut cmd = assert_cmd::Command::cargo_bin("weevil").unwrap();
let assert = cmd.arg("--help").assert();
assert
.success()
.stdout(predicates::prelude::predicate::str::contains("--proxy"))
.stdout(predicates::prelude::predicate::str::contains("--no-proxy"));
}
#[allow(deprecated)]
#[test]
fn cli_rejects_garbage_proxy_url() {
let mut cmd = assert_cmd::Command::cargo_bin("weevil").unwrap();
let assert = cmd
.arg("--proxy")
.arg("not-a-url-at-all")
.arg("sdk")
.arg("install")
.assert();
assert
.failure()
.stderr(predicates::prelude::predicate::str::contains("Invalid --proxy URL"));
}
#[allow(deprecated)]
#[test]
fn cli_proxy_and_no_proxy_are_mutually_exclusive_in_effect() {
let mut cmd = assert_cmd::Command::cargo_bin("weevil").unwrap();
let out = cmd
.arg("--proxy")
.arg("http://127.0.0.1:9999")
.arg("--no-proxy")
.arg("sdk")
.arg("install")
.output()
.expect("weevil binary failed to execute");
let stderr = String::from_utf8_lossy(&out.stderr);
assert!(!stderr.contains("panic"), "binary panicked: {}", stderr);
}