vagrant-orbstack 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +155 -0
- data/LICENSE +21 -0
- data/README.md +622 -0
- data/lib/vagrant-orbstack/action/create.rb +177 -0
- data/lib/vagrant-orbstack/action/destroy.rb +90 -0
- data/lib/vagrant-orbstack/action/halt.rb +64 -0
- data/lib/vagrant-orbstack/action/machine_validation.rb +60 -0
- data/lib/vagrant-orbstack/action/reload.rb +56 -0
- data/lib/vagrant-orbstack/action/ssh_run.rb +70 -0
- data/lib/vagrant-orbstack/action/start.rb +68 -0
- data/lib/vagrant-orbstack/action.rb +21 -0
- data/lib/vagrant-orbstack/config.rb +161 -0
- data/lib/vagrant-orbstack/errors.rb +64 -0
- data/lib/vagrant-orbstack/plugin.rb +45 -0
- data/lib/vagrant-orbstack/provider.rb +387 -0
- data/lib/vagrant-orbstack/util/machine_namer.rb +130 -0
- data/lib/vagrant-orbstack/util/orbstack_cli.rb +283 -0
- data/lib/vagrant-orbstack/util/ssh_readiness_checker.rb +115 -0
- data/lib/vagrant-orbstack/util/state_cache.rb +106 -0
- data/lib/vagrant-orbstack/version.rb +7 -0
- data/lib/vagrant-orbstack.rb +36 -0
- data/locales/en.yml +49 -0
- metadata +69 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: c6e4cc912454a6667b81c08430199300c42856659fb21257a2021fa7c08f816f
|
|
4
|
+
data.tar.gz: 86956a82e0ddab05df6bd614be9e7d9d1c9e738165ee7c45a9f1ac3c770c2194
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 38c114800c8d93b22982e9ac4714a229c3b46d73cfe4db9ac2310ce939b4e3b05f8001dc4b00d4da4f1315283c95a5e576f4e1b1e20fb1a512fa1fc19c5084f6
|
|
7
|
+
data.tar.gz: fa51ca790cc3078057dbcdc5a78794b2e2c89a96e1ec39dcd1c3619e3e4f26510e846404ca0c6ffda9a75865481fd19f63f8ebc65a750b4febff091e1268e499
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
|
|
16
|
+
## [0.1.0] - 2026-01-01
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- **SSH Connectivity** ([SPI-1225](https://linear.app/spiral-house/issue/SPI-1225))
|
|
21
|
+
- Implemented Provider#ssh_info method for SSH connection parameters
|
|
22
|
+
- Added OrbStack SSH proxy architecture support (localhost:32222 with ProxyCommand)
|
|
23
|
+
- Enabled SSH agent forwarding via `forward_agent` configuration attribute
|
|
24
|
+
- Configured automatic SSH key path resolution (~/.orbstack/ssh/id_ed25519)
|
|
25
|
+
- `vagrant ssh-config` command generates correct SSH configuration
|
|
26
|
+
- Direct SSH access works using Vagrant-generated configuration
|
|
27
|
+
- SSH readiness waiting after machine boot ([SPI-1226](https://linear.app/spiral-house/issue/SPI-1226))
|
|
28
|
+
- SSH verification tests ([SPI-1227](https://linear.app/spiral-house/issue/SPI-1227))
|
|
29
|
+
- SSH run action for `vagrant ssh -c` ([SPI-1240](https://linear.app/spiral-house/issue/SPI-1240))
|
|
30
|
+
- SSH error handling ([SPI-1224](https://linear.app/spiral-house/issue/SPI-1224))
|
|
31
|
+
- `ssh_username` configuration attribute ([SPI-1222](https://linear.app/spiral-house/issue/SPI-1222))
|
|
32
|
+
|
|
33
|
+
- **Machine Lifecycle Management**
|
|
34
|
+
- `vagrant up --provider=orbstack` creates and starts OrbStack machines ([SPI-1200](https://linear.app/spiral-house/issue/SPI-1200))
|
|
35
|
+
- `vagrant halt` stops running machines ([SPI-1201](https://linear.app/spiral-house/issue/SPI-1201))
|
|
36
|
+
- `vagrant destroy` removes machines and cleans up metadata ([SPI-1203](https://linear.app/spiral-house/issue/SPI-1203))
|
|
37
|
+
- `vagrant reload` restarts machines with fresh configuration ([SPI-1202](https://linear.app/spiral-house/issue/SPI-1202))
|
|
38
|
+
- Automatic machine naming with format `vagrant-<name>-<short-id>`
|
|
39
|
+
- Idempotent operations (safe to run commands multiple times)
|
|
40
|
+
- Multi-machine support with unique name collision avoidance
|
|
41
|
+
- State-aware operations (checks machine state before acting)
|
|
42
|
+
|
|
43
|
+
- **Machine State Query** ([SPI-1199](https://linear.app/spiral-house/issue/SPI-1199))
|
|
44
|
+
- Provider#state method returns accurate Vagrant::MachineState
|
|
45
|
+
- StateCache utility class with 5-second TTL for performance optimization
|
|
46
|
+
- State mapping: OrbStack states (running, stopped) → Vagrant states (:running, :stopped, :not_created)
|
|
47
|
+
- `vagrant status` command works correctly
|
|
48
|
+
- Cache invalidation support for fresh state queries
|
|
49
|
+
|
|
50
|
+
- **OrbStack CLI Integration** ([SPI-1198](https://linear.app/spiral-house/issue/SPI-1198))
|
|
51
|
+
- `list_machines` - retrieve all OrbStack machines
|
|
52
|
+
- `machine_info(name)` - query specific machine details
|
|
53
|
+
- `create_machine(name, distribution:)` - create new machines
|
|
54
|
+
- `start_machine(name)` - start stopped machines
|
|
55
|
+
- `stop_machine(name)` - stop running machines
|
|
56
|
+
- `delete_machine(name)` - remove machines
|
|
57
|
+
- Command execution with timeout support (default 30 seconds)
|
|
58
|
+
- Error handling (CommandTimeoutError, CommandExecutionError)
|
|
59
|
+
- OrbStack detection and availability checking
|
|
60
|
+
|
|
61
|
+
- **Configuration**
|
|
62
|
+
- `distro` - Linux distribution selection (default: "ubuntu")
|
|
63
|
+
- `version` - Distribution version specification
|
|
64
|
+
- `machine_name` - Custom machine naming
|
|
65
|
+
- `ssh_username` - SSH username configuration
|
|
66
|
+
- `forward_agent` - SSH agent forwarding control
|
|
67
|
+
|
|
68
|
+
- **Error Handling**
|
|
69
|
+
- I18n error messages and localization
|
|
70
|
+
- OrbStackNotInstalled error
|
|
71
|
+
- OrbStackNotRunning error
|
|
72
|
+
- CommandExecutionError for CLI failures
|
|
73
|
+
- CommandTimeoutError for CLI timeouts
|
|
74
|
+
- SSHNotReady error for SSH connectivity issues
|
|
75
|
+
- SSHConnectionFailed error
|
|
76
|
+
|
|
77
|
+
- **Development Infrastructure**
|
|
78
|
+
- Comprehensive test suite (617 passing tests)
|
|
79
|
+
- RuboCop configuration and compliance
|
|
80
|
+
- Git pre-push hooks for quality gates
|
|
81
|
+
- CI/CD pipeline with GitHub Actions
|
|
82
|
+
- YARD documentation
|
|
83
|
+
- Test coverage reporting
|
|
84
|
+
|
|
85
|
+
### Fixed
|
|
86
|
+
|
|
87
|
+
- I18n parameter passing in error classes ([SPI-1272](https://linear.app/spiral-house/issue/SPI-1272))
|
|
88
|
+
- Plugin loading errors ([SPI-1220](https://linear.app/spiral-house/issue/SPI-1220))
|
|
89
|
+
- E2E test exclusion from default rake task ([SPI-1278](https://linear.app/spiral-house/issue/SPI-1278))
|
|
90
|
+
|
|
91
|
+
### Changed
|
|
92
|
+
|
|
93
|
+
- Gemspec metadata updated for RubyGems publication ([SPI-1289](https://linear.app/spiral-house/issue/SPI-1289))
|
|
94
|
+
- Real author, email, homepage (Spiral House organization)
|
|
95
|
+
- Complete metadata hash with 6 required URIs
|
|
96
|
+
- `allowed_push_host` restriction to rubygems.org
|
|
97
|
+
|
|
98
|
+
### Known Limitations
|
|
99
|
+
|
|
100
|
+
- Box support not yet implemented (must use distribution-based creation)
|
|
101
|
+
- Synced folders not yet supported
|
|
102
|
+
- Networking configuration limited to OrbStack defaults
|
|
103
|
+
- Provisioners tested but not all scenarios covered
|
|
104
|
+
- macOS-only (OrbStack platform requirement)
|
|
105
|
+
|
|
106
|
+
## [0.0.1] - 2025-11-17
|
|
107
|
+
|
|
108
|
+
### Added
|
|
109
|
+
- Plugin registration with Vagrant v2 API (SPI-1130)
|
|
110
|
+
- Configuration class with provider-specific options:
|
|
111
|
+
- `distro` - Linux distribution selection (default: "ubuntu")
|
|
112
|
+
- `version` - Distribution version specification
|
|
113
|
+
- `machine_name` - Custom machine naming
|
|
114
|
+
- Provider class with Vagrant interface implementation (stubs)
|
|
115
|
+
- Version constant (`VERSION = "0.1.0"`)
|
|
116
|
+
- Comprehensive test suite:
|
|
117
|
+
- 39 passing RSpec tests
|
|
118
|
+
- 100% coverage of implemented features
|
|
119
|
+
- Plugin registration verification
|
|
120
|
+
- Configuration validation tests
|
|
121
|
+
- Provider interface tests
|
|
122
|
+
- Development infrastructure:
|
|
123
|
+
- RuboCop configuration for code quality
|
|
124
|
+
- RSpec configuration for testing
|
|
125
|
+
- Bundler setup for dependency management
|
|
126
|
+
- Gemspec for gem packaging
|
|
127
|
+
- YARD documentation for all public APIs
|
|
128
|
+
- Complete documentation set:
|
|
129
|
+
- README.md - User-facing documentation
|
|
130
|
+
- DEVELOPMENT.md - Contributor guide
|
|
131
|
+
- docs/PRD.md - Product requirements document
|
|
132
|
+
- docs/DESIGN.md - Technical design document
|
|
133
|
+
- docs/TDD.md - Test-driven development workflow
|
|
134
|
+
- Project conventions and standards:
|
|
135
|
+
- Trunk-based development workflow
|
|
136
|
+
- Conventional commits format
|
|
137
|
+
- Ruby style guide compliance
|
|
138
|
+
- Test-driven development process
|
|
139
|
+
|
|
140
|
+
### Technical Details
|
|
141
|
+
- Ruby 2.6+ compatibility
|
|
142
|
+
- Vagrant 2.2.0+ plugin API v2
|
|
143
|
+
- Zero RuboCop offenses
|
|
144
|
+
- MIT License
|
|
145
|
+
- macOS-only (OrbStack platform requirement)
|
|
146
|
+
|
|
147
|
+
### Notes
|
|
148
|
+
- This is an alpha release with foundational structure only
|
|
149
|
+
- Most provider features are stubs awaiting implementation
|
|
150
|
+
- Plugin can be installed but does not yet manage machines
|
|
151
|
+
- Focus of this release: establishing solid development foundation
|
|
152
|
+
|
|
153
|
+
[Unreleased]: https://github.com/spiralhouse/vagrant-orbstack-provider/compare/v0.1.0...HEAD
|
|
154
|
+
[0.1.0]: https://github.com/spiralhouse/vagrant-orbstack-provider/releases/tag/v0.1.0
|
|
155
|
+
[0.0.1]: https://github.com/spiralhouse/vagrant-orbstack-provider/releases/tag/v0.0.1
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 John Burbridge
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|