Merge pull request #1 from jay7x/wip

Add start/stop/delete/list tasks

Author: jay7x

Gemfile

@@ -13,23 +13,32 @@ def location_for(place_or_version, fake_version = nil)
   end
 end
 
-ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments
-minor_version = ruby_version_segments[0..1].join('.')
-
 group :development do
-  gem "json", '= 2.0.4',                                         require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.1.0',                                         require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "json", '= 2.3.0',                                         require: false if Gem::Requirement.create(['>= 2.7.0', '< 2.8.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
-  gem "puppet-module-posix-default-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby]
-  gem "puppet-module-posix-dev-r#{minor_version}", '~> 1.0',     require: false, platforms: [:ruby]
-  gem "puppet-module-win-default-r#{minor_version}", '~> 1.0',   require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "puppet-module-win-dev-r#{minor_version}", '~> 1.0',       require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "voxpupuli-puppet-lint-plugins", '>= 3.0',                 require: false
-  gem "github_changelog_generator", '~> 1.15',                   require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')
+  gem "json", '= 2.1.0',                               require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.3.0',                               require: false if Gem::Requirement.create(['>= 2.7.0', '< 3.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.5.1',                               require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.1',                               require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "json", '= 2.6.3',                               require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
+  gem "voxpupuli-puppet-lint-plugins", '~> 3.1',       require: false
+  gem "facterdb", '~> 1.18',                           require: false
+  gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0',     require: false
+  gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false
+  gem "rspec-puppet-facts", '~> 2.0',                  require: false
+  gem "codecov", '~> 0.2',                             require: false
+  gem "dependency_checker", '~> 0.2',                  require: false
+  gem "parallel_tests", '~> 3.4',                      require: false
+  gem "pry", '~> 0.10',                                require: false
+  gem "simplecov-console", '~> 0.5',                   require: false
+  gem "puppet-debugger", '~> 1.0',                     require: false
+  gem "rubocop", '= 1.6.1',                            require: false
+  gem "rubocop-performance", '= 1.9.1',                require: false
+  gem "rubocop-rspec", '= 2.0.1',                      require: false
+  gem "rb-readline", '= 0.5.5',                        require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "github_changelog_generator", '~> 1.15',         require: false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')
 end
 group :system_tests do
-  gem "puppet-module-posix-system-r#{minor_version}", '~> 1.0', require: false, platforms: [:ruby]
-  gem "puppet-module-win-system-r#{minor_version}", '~> 1.0',   require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet_litmus", '< 1.0.0', require: false, platforms: [:ruby]
+  gem "serverspec", '~> 2.41',    require: false
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']

REFERENCE.md

@@ -6,10 +6,54 @@
 
 ### Tasks
 
+* [`delete`](#delete): Delete Lima VM
+* [`list`](#list): Return list of Lima VMs
 * [`resolve_reference`](#resolve_reference): Generate Bolt targets from Lima VMs
+* [`start`](#start): Create or start Lima VM
+* [`stop`](#stop): Stop Lima VM
 
 ## Tasks
 
+### <a name="delete"></a>`delete`
+
+Delete Lima VM
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `limactl_path`
+
+Data type: `Optional[String[1]]`
+
+Location of the `limactl` binary if not in PATH
+
+##### `name`
+
+Data type: `String[1]`
+
+VM name
+
+### <a name="list"></a>`list`
+
+Return list of Lima VMs
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `limactl_path`
+
+Data type: `Optional[String[1]]`
+
+Location of the `limactl` binary if not in PATH
+
+##### `names`
+
+Data type: `Optional[Array[String[1]]]`
+
+VM names to list
+
 ### <a name="resolve_reference"></a>`resolve_reference`
 
 Generate Bolt targets from Lima VMs
@@ -36,3 +80,67 @@ Data type: `Optional[Pattern]`
 
 VMs with names matching this regex will be excluded from the inventory.
 
+### <a name="start"></a>`start`
+
+Create or start Lima VM
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `limactl_path`
+
+Data type: `Optional[String[1]]`
+
+Location of the `limactl` binary if not in PATH
+
+##### `name`
+
+Data type: `String[1]`
+
+VM name
+
+##### `timeout`
+
+Data type: `Optional[String[1]]`
+
+Duration to wait for the instance to be running before timing out
+
+##### `url`
+
+Data type: `Optional[String[1]]`
+
+Remote URL containing YAML configuration to create the instance from
+
+##### `template`
+
+Data type: `Optional[String[1]]`
+
+Lima template to create the instance from
+
+##### `config`
+
+Data type: `Optional[Hash]`
+
+Configuration hash to create the instance from
+
+### <a name="stop"></a>`stop`
+
+Stop Lima VM
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `limactl_path`
+
+Data type: `Optional[String[1]]`
+
+Location of the `limactl` binary if not in PATH
+
+##### `name`
+
+Data type: `String[1]`
+
+VM name
+

metadata.json

@@ -8,7 +8,10 @@
   "project_page": "https://github.com/jay7x/puppet-lima",
   "issues_url": "https://github.com/jay7x/puppet-lima/issues",
   "dependencies": [
-    {"name":"puppetlabs-ruby_task_helper","version_requirement":">= 0.1.0 < 1.0.0"}
+    {
+      "name": "puppetlabs-ruby_task_helper",
+      "version_requirement": ">= 0.1.0 < 1.0.0"
+    }
   ],
   "operatingsystem_support": [
     {
@@ -72,7 +75,7 @@
       "version_requirement": ">= 4.10.0 < 9.0.0"
     }
   ],
-  "pdk-version": "2.5.0",
-  "template-url": "https://github.com/puppetlabs/pdk-templates#2.5.0",
-  "template-ref": "tags/2.5.0-0-g369d483"
+  "pdk-version": "2.6.1",
+  "template-url": "https://github.com/puppetlabs/pdk-templates#2.7.1",
+  "template-ref": "tags/2.7.1-0-g9a16c87"
 }

spec/tasks/lima_delete_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../tasks/delete.rb'
+
+describe LimaDelete do
+  let(:task) { described_class.new }
+  let(:lima_stdout) { 'Lima message' }
+  let(:lima_stderr) { '' }
+  let(:lima_code) { 0 }
+  let(:lima_response) { [lima_stdout, lima_stderr, lima_code] }
+  let(:success_result) { { stdout: lima_stdout } }
+
+  describe '#delete' do
+    context 'with name specified' do
+      vm_name = 'test'
+      let(:opts) { { name: vm_name } }
+
+      it "invokes `lima delete #{vm_name}`" do
+        expect(Open3).to receive(:capture3).with('limactl', 'delete', vm_name).and_return(lima_response)
+        result = task.delete(opts)
+        expect(result).to eq(success_result)
+      end
+    end
+  end
+end

spec/tasks/lima_list_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../tasks/list.rb'
+
+describe LimaList do
+  let(:task) { described_class.new }
+  let(:vms) do
+    [
+      { 'name': 'default' },
+      { 'name': 'test' },
+      { 'name': 'example' },
+    ]
+  end
+  let(:lima_stdout) do
+    <<~LIMASTR
+      {"name":"default"}
+      {"name":"test"}
+      {"name":"example"}
+    LIMASTR
+  end
+  let(:lima_stderr) { '' }
+  let(:lima_code) { 0 }
+  let(:lima_response) { [lima_stdout, lima_stderr, lima_code] }
+  let(:success_result) { { list: vms.map { |x| x.transform_keys(&:to_s) } } }
+
+  describe '#list' do
+    context 'with names specified' do
+      let(:opts) { { names: ['test', 'example'] } }
+
+      it 'returns VM list' do
+        expect(Open3).to receive(:capture3).with('limactl', 'list', '--json', *opts[:names]).and_return(lima_response)
+        result = task.list(opts)
+        expect(result).to eq(success_result)
+      end
+    end
+
+    context 'without names specified' do
+      let(:opts) { {} }
+
+      it 'returns VM list' do
+        expect(Open3).to receive(:capture3).with('limactl', 'list', '--json').and_return(lima_response)
+        result = task.list(opts)
+        expect(result).to eq(success_result)
+      end
+    end
+  end
+end