pvectl 0.2.0

data/lib/pvectl.rb

@@ -0,0 +1,439 @@
+# frozen_string_literal: true
+
+require_relative "pvectl/version"
+require_relative "pvectl/exit_codes"
+require_relative "pvectl/config_serializer"
+require_relative "pvectl/manifest_serializer"
+require_relative "pvectl/editor_session"
+
+# Main module for the pvectl application - CLI tool for managing Proxmox clusters.
+#
+# Pvectl provides a kubectl-style command line interface for managing
+# virtual machines, containers, nodes, storage, and backups in Proxmox VE.
+#
+# @example Usage in code
+#   Pvectl::CLI.run(ARGV)
+#
+# @see Pvectl::CLI Main CLI class
+# @see Pvectl::ExitCodes Application exit codes
+#
+module Pvectl
+  # Base error class for all pvectl-specific exceptions.
+  #
+  # All custom errors in the application should inherit from this class,
+  # which allows for easy catching of all pvectl errors.
+  #
+  # @example Creating a custom error
+  #   class ConnectionError < Pvectl::Error; end
+  #
+  # @example Catching pvectl errors
+  #   begin
+  #     # pvectl operations
+  #   rescue Pvectl::Error => e
+  #     puts "pvectl error: #{e.message}"
+  #   end
+  #
+  class Error < StandardError; end
+
+  # Raised when a requested resource is not found.
+  #
+  # @example
+  #   raise Pvectl::ResourceNotFoundError, "Node not found: pve1"
+  #
+  class ResourceNotFoundError < Error; end
+end
+
+require_relative "pvectl/argv_preprocessor"
+
+# Configuration management
+require_relative "pvectl/config/errors"
+require_relative "pvectl/config/models/cluster"
+require_relative "pvectl/config/models/user"
+require_relative "pvectl/config/models/context"
+require_relative "pvectl/config/models/resolved_config"
+require_relative "pvectl/config/provider"
+require_relative "pvectl/config/store"
+require_relative "pvectl/config/wizard"
+require_relative "pvectl/config/service"
+
+# Formatters
+require_relative "pvectl/formatters/base"
+require_relative "pvectl/formatters/color_support"
+require_relative "pvectl/formatters/table"
+require_relative "pvectl/formatters/wide"
+require_relative "pvectl/formatters/json"
+require_relative "pvectl/formatters/yaml"
+require_relative "pvectl/formatters/registry"
+require_relative "pvectl/formatters/output_helper"
+
+# Models
+require_relative "pvectl/models/base"
+require_relative "pvectl/models/apt_package"
+require_relative "pvectl/models/network_interface"
+require_relative "pvectl/models/physical_disk"
+require_relative "pvectl/models/service"
+require_relative "pvectl/models/vm"
+require_relative "pvectl/models/node"
+require_relative "pvectl/models/storage"
+require_relative "pvectl/models/snapshot"
+require_relative "pvectl/models/snapshot_description"
+require_relative "pvectl/models/backup"
+require_relative "pvectl/models/container"
+require_relative "pvectl/models/task"
+require_relative "pvectl/models/operation_result"
+require_relative "pvectl/models/vm_operation_result"
+require_relative "pvectl/models/container_operation_result"
+require_relative "pvectl/models/node_operation_result"
+require_relative "pvectl/models/volume_operation_result"
+require_relative "pvectl/models/task_entry"
+require_relative "pvectl/models/syslog_entry"
+require_relative "pvectl/models/journal_entry"
+require_relative "pvectl/models/task_log_line"
+require_relative "pvectl/models/volume"
+require_relative "pvectl/models/dns_config"
+require_relative "pvectl/models/time_config"
+require_relative "pvectl/models/hosts_file"
+require_relative "pvectl/models/capability"
+require_relative "pvectl/models/subscription"
+
+# Repositories
+require_relative "pvectl/repositories/base"
+require_relative "pvectl/repositories/apt"
+require_relative "pvectl/repositories/vm"
+require_relative "pvectl/repositories/node"
+require_relative "pvectl/repositories/storage"
+require_relative "pvectl/repositories/container"
+require_relative "pvectl/repositories/task"
+require_relative "pvectl/repositories/snapshot"
+require_relative "pvectl/repositories/backup"
+require_relative "pvectl/repositories/task_list"
+require_relative "pvectl/repositories/syslog"
+require_relative "pvectl/repositories/journal"
+require_relative "pvectl/repositories/task_log"
+require_relative "pvectl/repositories/disk"
+require_relative "pvectl/repositories/volume"
+require_relative "pvectl/repositories/dns"
+require_relative "pvectl/repositories/service"
+require_relative "pvectl/repositories/time_config"
+require_relative "pvectl/repositories/hosts"
+require_relative "pvectl/repositories/capabilities"
+require_relative "pvectl/repositories/subscription"
+
+# Presenters
+require_relative "pvectl/presenters/base"
+require_relative "pvectl/presenters/apt_package"
+require_relative "pvectl/presenters/config/context"
+require_relative "pvectl/presenters/vm"
+require_relative "pvectl/presenters/node"
+require_relative "pvectl/presenters/top_presenter"
+require_relative "pvectl/presenters/top_node"
+require_relative "pvectl/presenters/top_vm"
+require_relative "pvectl/presenters/storage"
+require_relative "pvectl/presenters/container"
+require_relative "pvectl/presenters/top_container"
+require_relative "pvectl/presenters/operation_result"
+require_relative "pvectl/presenters/vm_operation_result"
+require_relative "pvectl/presenters/container_operation_result"
+require_relative "pvectl/presenters/node_operation_result"
+require_relative "pvectl/presenters/volume_operation_result"
+require_relative "pvectl/presenters/snapshot"
+require_relative "pvectl/presenters/snapshot_operation_result"
+require_relative "pvectl/presenters/backup"
+require_relative "pvectl/presenters/template"
+require_relative "pvectl/presenters/task_entry"
+require_relative "pvectl/presenters/syslog_entry"
+require_relative "pvectl/presenters/journal_entry"
+require_relative "pvectl/presenters/task_log_line"
+require_relative "pvectl/presenters/disk"
+require_relative "pvectl/presenters/volume"
+require_relative "pvectl/presenters/dns_config"
+require_relative "pvectl/presenters/service"
+require_relative "pvectl/presenters/time_config"
+require_relative "pvectl/presenters/hosts_file"
+require_relative "pvectl/presenters/capability"
+require_relative "pvectl/presenters/subscription"
+
+# Selectors
+require_relative "pvectl/selectors/base"
+require_relative "pvectl/selectors/vm"
+require_relative "pvectl/selectors/container"
+require_relative "pvectl/selectors/disk"
+require_relative "pvectl/selectors/volume"
+
+# Console
+require_relative "pvectl/console/terminal_session"
+
+# Connection
+require_relative "pvectl/connection/retry_handler"
+require_relative "pvectl/connection"
+
+# Utils
+require_relative "pvectl/utils/resource_resolver"
+
+# Parsers
+require_relative "pvectl/parsers/disk_config"
+require_relative "pvectl/parsers/net_config"
+require_relative "pvectl/parsers/cloud_init_config"
+require_relative "pvectl/parsers/lxc_mount_config"
+require_relative "pvectl/parsers/lxc_net_config"
+require_relative "pvectl/parsers/smart_text"
+
+# Commands
+require_relative "pvectl/commands/config/use_context"
+require_relative "pvectl/commands/config/get_contexts"
+require_relative "pvectl/commands/config/set_context"
+require_relative "pvectl/commands/config/set_cluster"
+require_relative "pvectl/commands/config/set_credentials"
+require_relative "pvectl/commands/config/view"
+require_relative "pvectl/commands/config/command"
+require_relative "pvectl/commands/cloudinit/regenerate"
+require_relative "pvectl/commands/cloudinit/pending"
+require_relative "pvectl/commands/cloudinit/dump"
+require_relative "pvectl/commands/cloudinit/command"
+require_relative "pvectl/commands/ping"
+require_relative "pvectl/commands/apt"
+
+# Services - Get
+require_relative "pvectl/services/get/resource_service"
+
+# Services - Lifecycle
+require_relative "pvectl/services/vm_lifecycle"
+require_relative "pvectl/services/container_lifecycle"
+
+# Services - Snapshot
+require_relative "pvectl/services/snapshot"
+
+# Services - Cloudinit
+require_relative "pvectl/services/cloudinit"
+
+# Services - Backup
+require_relative "pvectl/services/backup"
+
+# Services - Resource Delete
+require_relative "pvectl/services/resource_delete"
+
+# Services - Clone VM
+require_relative "pvectl/services/clone_vm"
+
+# Services - Create VM
+require_relative "pvectl/services/create_vm"
+
+# Services - Create Container
+require_relative "pvectl/services/create_container"
+
+# Services - Edit VM
+require_relative "pvectl/services/edit_vm"
+
+# Services - Edit Container
+require_relative "pvectl/services/edit_container"
+
+# Services - Edit Node
+require_relative "pvectl/services/edit_node"
+
+# Services - Edit DNS
+require_relative "pvectl/services/edit_dns"
+
+# Services - Edit Hosts
+require_relative "pvectl/services/edit_hosts"
+
+# Services - Edit Volume
+require_relative "pvectl/services/edit_volume"
+
+# Services - Set VM
+require_relative "pvectl/services/set_vm"
+
+# Services - Set Container
+require_relative "pvectl/services/set_container"
+
+# Services - Set Node
+require_relative "pvectl/services/set_node"
+
+# Services - Resize Volume
+require_relative "pvectl/services/resize_volume"
+
+# Services - Sendkey
+require_relative "pvectl/services/sendkey"
+
+# Services - Unlink Disk
+require_relative "pvectl/services/unlink_disk"
+
+# Services - Set Volume
+require_relative "pvectl/services/set_volume"
+
+# Services - Clone Container
+require_relative "pvectl/services/clone_container"
+
+# Services - Resource Migration
+require_relative "pvectl/services/resource_migration"
+
+# Services - Move Disk
+require_relative "pvectl/services/move_disk"
+
+# Services - Console
+require_relative "pvectl/services/console"
+
+# Services - Task Listing
+require_relative "pvectl/services/task_listing"
+
+# Services - Pull Config
+require_relative "pvectl/services/pull_config"
+
+# Services - Push Config
+require_relative "pvectl/services/push_config"
+
+# Services - Service Lifecycle (systemd services on nodes)
+require_relative "pvectl/services/service_lifecycle"
+
+# Services - Wakeonlan
+require_relative "pvectl/services/wakeonlan"
+
+# Commands - Base
+require_relative "pvectl/commands/resource_registry"
+require_relative "pvectl/commands/shared_flags"
+require_relative "pvectl/commands/shared_config_parsers"
+
+# Commands - Get
+require_relative "pvectl/commands/get/resource_handler"
+require_relative "pvectl/commands/get/resource_registry"
+require_relative "pvectl/commands/get/watch_loop"
+require_relative "pvectl/commands/get/command"
+require_relative "pvectl/commands/get/handlers/vms"
+require_relative "pvectl/commands/get/handlers/nodes"
+require_relative "pvectl/commands/get/handlers/storage"
+require_relative "pvectl/commands/get/handlers/containers"
+require_relative "pvectl/commands/get/handlers/snapshots"
+require_relative "pvectl/commands/get/handlers/backups"
+require_relative "pvectl/commands/get/handlers/tasks"
+require_relative "pvectl/commands/get/handlers/templates"
+require_relative "pvectl/commands/get/handlers/disks"
+require_relative "pvectl/commands/get/handlers/volume"
+require_relative "pvectl/commands/get/handlers/dns"
+require_relative "pvectl/commands/get/handlers/services"
+require_relative "pvectl/commands/get/handlers/time"
+require_relative "pvectl/commands/get/handlers/hosts"
+require_relative "pvectl/commands/get/handlers/capabilities"
+require_relative "pvectl/commands/get/handlers/subscription"
+
+# Commands - Describe
+require_relative "pvectl/commands/describe/command"
+
+# Commands - Top
+require_relative "pvectl/commands/top/resource_registry"
+require_relative "pvectl/commands/top/resource_handler"
+require_relative "pvectl/commands/top/command"
+require_relative "pvectl/commands/top/handlers/nodes"
+require_relative "pvectl/commands/top/handlers/vms"
+require_relative "pvectl/commands/top/handlers/containers"
+
+# Commands - Logs
+require_relative "pvectl/commands/logs/resource_registry"
+require_relative "pvectl/commands/logs/resource_handler"
+require_relative "pvectl/commands/logs/command"
+require_relative "pvectl/commands/logs/handlers/task_logs"
+require_relative "pvectl/commands/logs/handlers/syslog"
+require_relative "pvectl/commands/logs/handlers/journal"
+require_relative "pvectl/commands/logs/handlers/task_detail"
+
+# Commands - Lifecycle
+require_relative "pvectl/commands/resource_lifecycle_command"
+require_relative "pvectl/commands/vm_lifecycle_command"
+require_relative "pvectl/commands/container_lifecycle_command"
+require_relative "pvectl/commands/irreversible_command"
+require_relative "pvectl/commands/delete_command"
+require_relative "pvectl/commands/delete_vm"
+require_relative "pvectl/commands/delete_container"
+require_relative "pvectl/commands/template_command"
+require_relative "pvectl/commands/template_vm"
+require_relative "pvectl/commands/template_container"
+require_relative "pvectl/commands/start"
+require_relative "pvectl/commands/stop"
+require_relative "pvectl/commands/shutdown"
+require_relative "pvectl/commands/restart"
+require_relative "pvectl/commands/reset"
+require_relative "pvectl/commands/suspend"
+require_relative "pvectl/commands/resume"
+require_relative "pvectl/commands/start_container"
+require_relative "pvectl/commands/stop_container"
+require_relative "pvectl/commands/shutdown_container"
+require_relative "pvectl/commands/restart_container"
+
+# Commands - Create
+require_relative "pvectl/commands/create_snapshot"
+require_relative "pvectl/commands/create_backup"
+require_relative "pvectl/commands/create_resource_command"
+require_relative "pvectl/commands/create_vm"
+require_relative "pvectl/commands/create_container"
+
+# Commands - Edit
+require_relative "pvectl/commands/edit_resource_command"
+require_relative "pvectl/commands/edit_vm"
+require_relative "pvectl/commands/edit_container"
+require_relative "pvectl/commands/edit_node"
+require_relative "pvectl/commands/edit_volume"
+require_relative "pvectl/commands/edit_dns"
+require_relative "pvectl/commands/edit_hosts"
+
+# Commands - Set
+require_relative "pvectl/commands/set_resource_command"
+require_relative "pvectl/commands/set_vm"
+require_relative "pvectl/commands/set_container"
+require_relative "pvectl/commands/set_node"
+require_relative "pvectl/commands/set_volume"
+
+# Commands - Delete
+require_relative "pvectl/commands/delete_snapshot"
+require_relative "pvectl/commands/delete_backup"
+
+# Commands - Rollback
+require_relative "pvectl/commands/rollback_snapshot"
+
+# Commands - Restore
+require_relative "pvectl/commands/restore_backup"
+
+# Commands - Clone
+require_relative "pvectl/commands/clone_vm"
+require_relative "pvectl/commands/clone_container"
+
+# Commands - Migrate
+require_relative "pvectl/commands/migrate_command"
+require_relative "pvectl/commands/migrate_vm"
+require_relative "pvectl/commands/migrate_container"
+require_relative "pvectl/commands/move_disk_command"
+require_relative "pvectl/commands/move_disk_vm"
+require_relative "pvectl/commands/move_disk_container"
+
+# Commands - Feature
+require_relative "pvectl/commands/feature_command"
+require_relative "pvectl/commands/feature_vm"
+require_relative "pvectl/commands/feature_container"
+
+# Commands - Console
+require_relative "pvectl/commands/console_vm"
+require_relative "pvectl/commands/console_ct"
+require_relative "pvectl/commands/console"
+
+# Sendkey
+require_relative "pvectl/commands/sendkey_vm"
+
+# Commands - Pull
+require_relative "pvectl/commands/pull"
+
+# Commands - Push
+require_relative "pvectl/commands/push"
+
+# Commands - Service (systemd lifecycle on nodes)
+require_relative "pvectl/commands/service"
+
+# Commands - Wakeonlan
+require_relative "pvectl/commands/wakeonlan_node"
+
+# Commands - Unlink
+require_relative "pvectl/commands/unlink_disk_vm"
+
+# Wizards
+require_relative "pvectl/wizards/create_vm"
+require_relative "pvectl/wizards/create_container"
+
+require_relative "pvectl/plugin_loader"
+
+require_relative "pvectl/cli"

data/sig/external/gli.rbs

@@ -0,0 +1,16 @@
+module GLI
+  class App
+    def desc: (String description) -> void
+    def long_desc: (String description) -> void
+    def command: (*Symbol names) { (Command) -> void } -> void
+    def flag: (Symbol | Array[Symbol] names, ?desc: String, ?default_value: untyped, ?type: untyped, ?must_match: untyped) -> void
+    def switch: (Symbol | Array[Symbol] names, ?desc: String, ?negatable: bool, ?default_value: bool) -> void
+    def action: () { (Hash[Symbol, untyped], Hash[Symbol, untyped], Array[String]) -> void } -> void
+    def arg_name: (String name, ?Symbol optionality) -> void
+    def skips_pre: () -> void
+    def skips_post: () -> void
+  end
+
+  class Command < App
+  end
+end

data/sig/external/proxmox_api.rbs

@@ -0,0 +1,10 @@
+module ProxmoxAPI
+  class ApiClient
+    def initialize: (String uri, ?Hash[Symbol, untyped] options) -> void
+    def []: (String path) -> untyped
+    def get: (?params: Hash[Symbol, untyped]) -> untyped
+    def post: (?Hash[Symbol, untyped] params) -> untyped
+    def put: (?Hash[Symbol, untyped] params) -> untyped
+    def delete: (?Hash[Symbol, untyped] params) -> untyped
+  end
+end

data/sig/pvectl/argv_preprocessor.rbs

@@ -0,0 +1,53 @@
+module Pvectl
+  class ArgvPreprocessor
+    MAX_ARGUMENTS: Integer
+
+    MAX_ARGUMENT_LENGTH: Integer
+
+    PASSTHROUGH_FLAGS: Array[String]
+
+    class DuplicateFlagError < Pvectl::Error
+      def initialize: (Symbol flag_name, (String | bool) existing_value, (String | bool) new_value) -> void
+    end
+
+    def self.process: (Array[String] argv, ?cli_app: untyped) -> Array[String]
+
+    def initialize: (Array[String] argv, ?cli_app: untyped) -> void
+
+    def call: () -> Array[String]
+
+    private
+
+    @argv: Array[String]
+
+    @cli_app: untyped
+
+    def validate_input_limits!: () -> void
+
+    def passthrough_mode?: () -> bool
+
+    def reorder_all_flags: () -> Array[String]
+
+    def extract_global_flags: (Array[String] args) -> [Array[String], Array[String]]
+
+    def find_global_flag: (String arg) -> [Symbol, bool]?
+
+    def flag_matches?: (untyped gli_flag, String flag_part) -> bool
+
+    def flag_display_name: (untyped gli_flag) -> Symbol
+
+    def store_global_flag: (Hash[Symbol, String | bool] store, Symbol name, String | bool value) -> void
+
+    def validate_value!: (String | bool value, Symbol flag_name) -> void
+
+    def identify_command: (Array[String] args) -> [String?, Array[String], Array[String]]
+
+    def find_gli_command: (String name) -> untyped
+
+    def find_gli_subcommand: (untyped cmd, String name) -> untyped
+
+    def reorder_command_flags: (Array[String] args, untyped cmd) -> Array[String]
+
+    def find_command_flag: (String arg, untyped cmd) -> bool?
+  end
+end

data/sig/pvectl/cli.rbs

@@ -0,0 +1,26 @@
+module Pvectl
+  class CLI
+    # GLI::App methods provided via extend
+    def self.program_desc: (String desc) -> void
+
+    def self.version: (String version) -> void
+
+    def self.subcommand_option_handling: (Symbol mode) -> void
+
+    def self.desc: (String description) -> void
+
+    def self.arg_name: (String name) -> void
+
+    def self.default_value: (untyped value) -> void
+
+    def self.flag: (Array[Symbol] names, **untyped options) -> void
+
+    def self.switch: (Array[Symbol] names, **untyped options) -> void
+
+    def self.on_error: () { (Exception) -> void } -> void
+
+    def self.run: (Array[String] argv) -> Integer
+
+    def self.trap: (String signal) { () -> void } -> void
+  end
+end

data/sig/pvectl/commands/apt.rbs

@@ -0,0 +1,47 @@
+module Pvectl
+  module Commands
+    class Apt
+      def self.register: (untyped cli) -> void
+
+      def self.register_list: (untyped parent) -> void
+
+      def self.register_update: (untyped parent) -> void
+
+      def self.register_changelog: (untyped parent) -> void
+
+      def self.register_versions: (untyped parent) -> void
+
+      def self.execute: (Symbol operation, Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options) -> Integer
+
+      def initialize: (Symbol operation, Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options, ?output: untyped) -> void
+
+      def execute: () -> Integer
+
+      private
+
+      def load_config: () -> void
+
+      def resolve_node: () -> String?
+
+      def repository: () -> Repositories::Apt
+
+      def run_list: (String node) -> Integer
+
+      def run_update: (String node) -> Integer
+
+      def run_changelog: (String node) -> Integer
+
+      def run_versions: (String node) -> Integer
+
+      def render_packages: (Array[Models::AptPackage] packages) -> void
+
+      def render_operation_result: (Models::NodeOperationResult result) -> void
+
+      def build_update_result: (String node, String upid) -> Models::NodeOperationResult
+
+      def usage_error: (String message) -> Integer
+
+      def config_error: (String message) -> Integer
+    end
+  end
+end

data/sig/pvectl/commands/clone_container.rbs

@@ -0,0 +1,31 @@
+module Pvectl
+  module Commands
+    class CloneContainer
+      include SharedConfigParsers
+
+      def self.execute: (Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options) -> Integer
+
+      def initialize: (Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options) -> void
+
+      def execute: () -> Integer
+
+      private
+
+      def perform_clone: (Integer ctid, Hash[Symbol, untyped] config_params) -> Integer
+
+      def print_progress: (untyped result) -> void
+
+      def load_config: () -> void
+
+      def service_options: () -> Hash[Symbol, untyped]
+
+      def output_result: (untyped result) -> void
+
+      def display_clone_summary: (Integer ctid, Hash[Symbol, untyped] config_params) -> Symbol?
+
+      def display_config_changes: (Hash[Symbol, untyped] params) -> void
+
+      def usage_error: (String message) -> Integer
+    end
+  end
+end

data/sig/pvectl/commands/clone_vm.rbs

@@ -0,0 +1,33 @@
+module Pvectl
+  module Commands
+    class CloneVm
+      include SharedConfigParsers
+
+      def self.register: (untyped cli) -> void
+
+      def self.execute: (Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options) -> Integer
+
+      def initialize: (Array[String] args, Hash[Symbol, untyped] options, Hash[Symbol, untyped] global_options) -> void
+
+      def execute: () -> Integer
+
+      private
+
+      def perform_clone: (Integer vmid, Hash[Symbol, untyped] config_params) -> Integer
+
+      def print_progress: (untyped result) -> void
+
+      def load_config: () -> void
+
+      def service_options: () -> Hash[Symbol, untyped]
+
+      def output_result: (untyped result) -> void
+
+      def display_clone_summary: (Integer vmid, Hash[Symbol, untyped] config_params) -> Symbol?
+
+      def display_config_changes: (Hash[Symbol, untyped] params) -> void
+
+      def usage_error: (String message) -> Integer
+    end
+  end
+end

data/sig/pvectl/commands/cloudinit/command.rbs

@@ -0,0 +1,13 @@
+module Pvectl
+  module Commands
+    module Cloudinit
+      def self.register: (untyped cli) -> void
+
+      def self.with_service: (Hash[Symbol, untyped] global_options) { (Pvectl::Services::Cloudinit) -> void } -> Integer
+
+      def self.usage_error: (String message) -> Integer
+
+      def self.unknown_resource_type: (String resource_type) -> Integer
+    end
+  end
+end