Class: Pvectl::Services::EditVm

Inherits:
Object
  • Object
show all
Defined in:
lib/pvectl/services/edit_vm.rb,
sig/pvectl/services/edit_vm.rbs

Overview

Orchestrates the interactive VM configuration editing flow.

Fetches current config, opens it in an editor as structured YAML, validates changes, computes a diff, and applies updates via the API. Supports dry-run mode and optimistic locking via digest.

Examples:

Basic usage

service = EditVm.new(vm_repository: repo)
result = service.execute(vmid: 100)

Dry run with injected editor session

service = EditVm.new(vm_repository: repo, editor_session: session,
                     options: { dry_run: true })
result = service.execute(vmid: 100)

Instance Method Summary collapse

Constructor Details

#initialize(vm_repository:, editor_session: nil, options: {}) ⇒ EditVm

Creates a new EditVm service.

Parameters:

  • VM repository

  • (defaults to: nil)

    optional injected editor session

  • (defaults to: {})

    options (dry_run)

  • (defaults to: nil)
  • (defaults to: {}) 


26
27
28
29
30
 
# File 'lib/pvectl/services/edit_vm.rb', line 26

def initialize(vm_repository:, editor_session: nil, options: {})
  @vm_repository = vm_repository
  @editor_session = editor_session
  @options = options
end

Instance Method Details

#build_result(resource_info, **attrs) ⇒ Models::VmOperationResult

Builds a VmOperationResult with the :edit operation.

Parameters:

  • resource info (vmid, node, status)

  • additional result attributes

Returns:



106
107
108
109
110
111
112
113
114
 
# File 'lib/pvectl/services/edit_vm.rb', line 106

def build_result(resource_info, **attrs)
  vm = Models::Vm.new(
    vmid: resource_info[:vmid],
    node: resource_info[:node]
  )
  Models::VmOperationResult.new(
    operation: :edit, vm: vm, resource: resource_info, **attrs
  )
end

#build_update_params(changes, original_config) ⇒ Hash

Builds API update parameters from a diff hash.

Maps changed/added keys to their new values, removed keys to the Proxmox delete parameter, and includes digest for optimistic locking.

Parameters:

  • diff hash with :changed, :added, :removed

  • original flat config (for digest)

Returns:

  • Proxmox API parameters



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/pvectl/services/edit_vm.rb', line 90

def build_update_params(changes, original_config)
  params = {}
  changes[:changed].each { |key, (_old, new_val)| params[key] = new_val }
  changes[:added].each { |key, val| params[key] = val }
  unless changes[:removed].empty?
    params[:delete] = changes[:removed].map(&:to_s).join(",")
  end
  params[:digest] = original_config[:digest] if original_config[:digest]
  params
end

#execute(vmid:) ⇒ Models::VmOperationResult?

Executes the interactive VM edit flow.

Parameters:

  • VM identifier

Returns:

  • operation result, or nil if cancelled/no changes



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pvectl/services/edit_vm.rb', line 36

def execute(vmid:)
  vm = @vm_repository.get(vmid)
  return not_found_result(vmid) unless vm

  config = @vm_repository.fetch_config(vm.node, vmid)
  resource_info = { vmid: vmid, node: vm.node, status: vm.status }

  yaml_content = ConfigSerializer.to_yaml(config, type: :vm, resource: resource_info)

  validator = ->(content) { ConfigSerializer.validate(content, type: :vm) }
  session = @editor_session || EditorSession.new(validator: validator)
  edited = session.edit(yaml_content)

  return nil unless edited

  original_roundtrip = ConfigSerializer.from_yaml(yaml_content, type: :vm)
  edited_flat = ConfigSerializer.from_yaml(edited, type: :vm)

  violations = ConfigSerializer.readonly_violations(original_roundtrip, edited_flat, type: :vm)
  unless violations.empty?
    return build_result(resource_info, success: false,
                        error: "Read-only fields cannot be changed: #{violations.join(', ')}")
  end

  changes = ConfigSerializer.diff(original_roundtrip, edited_flat)

  if changes[:changed].empty? && changes[:added].empty? && changes[:removed].empty?
    return nil
  end

  params = build_update_params(changes, config)

  resource_info[:diff] = changes

  if @options[:dry_run]
    return build_result(resource_info, success: true)
  end

  @vm_repository.update(vmid, vm.node, params)
  build_result(resource_info, success: true)
rescue StandardError => e
  build_result({ vmid: vmid }, success: false, error: e.message)
end

#not_found_result(vmid) ⇒ Models::VmOperationResult

Builds a not-found error result.

Parameters:

  • VM identifier

Returns:



120
121
122
 
# File 'lib/pvectl/services/edit_vm.rb', line 120

def not_found_result(vmid)
  build_result({ vmid: vmid }, success: false, error: "VM #{vmid} not found")
end