vop-plugins 0.3.1 → 0.3.5

data/standard/git/commands/deploy_from_github.rb

@@ -0,0 +1,12 @@
+param! :machine
+param! "github_project", description: "full name (author/repo) of the project that should be checked out"
+param! "domain", multi: true, description: "the domain on which the project should be deployed"
+param "subfolder", description: "folder inside git checkout that should be published (as web root)"
+
+contribute to: "deploy" do |params, github_project|
+  params.delete("github_project")
+
+  @op.deploy_from_git(
+    params.merge("git_url" => "https://github.com/#{github_project}.git")
+  )
+end

data/standard/git/commands/git_clone.rb

@@ -0,0 +1,7 @@
+param! :machine
+param! "url", default_param: true
+param "dir"
+
+run do |machine, url, dir|
+  machine.ssh("git clone #{url} #{dir}")
+end

data/standard/git/commands/git_clone_web.rb

@@ -0,0 +1,22 @@
+param! :machine
+param! "url", default_param: true
+
+run do |machine, url|
+  project_name = nil
+  if /\/([^\/]+)\.git$/.match(url)
+    project_name = $1
+  end
+  if project_name.nil?
+    raise "could not determine project_name from Git URL: unexpected format #{url}"
+  end
+
+  dir = "/var/www/#{project_name}"
+  unless machine.file_exists(dir)
+    machine.sudo("mkdir #{dir}")
+    # TODO hardcoded marvin
+    machine.sudo("chown marvin:www-data #{dir}")
+    machine.git_clone("url" => url, "dir" => dir)
+  end
+
+  dir
+end

data/standard/linux/commands/append_to_file.rb

@@ -0,0 +1,14 @@
+description "appends content to a file (without locking, be careful)"
+
+param! :machine
+param! "file_name", "the target file to append content to. will be created if it doesn't exist."
+param! "content", "the content to add to the file"
+
+run do |machine, file_name, content|
+  old_content = machine.file_exists(file_name) ?
+    machine.read_file(file_name) : nil
+
+  new_content = [ old_content, content ].join("\n")
+
+  machine.write_file("file_name" => file_name, "content" => new_content)
+end

data/standard/linux/commands/chmod.rb

@@ -0,0 +1,7 @@
+param! :machine
+param! "file"
+param! "permissions"
+
+run do |machine, file, permissions|
+  machine.ssh("chmod #{permissions} #{file}")
+end

data/standard/linux/commands/curl.rb

@@ -0,0 +1,15 @@
+param! :machine
+param! "url", default_param: true
+
+run do |machine, url|
+  has_curl = machine.ssh("which curl")
+
+  $logger.debug "has_curl: #{has_curl}"
+  raise "no curl" unless has_curl
+
+  command = "curl --location"
+  command += " '#{url}'"
+
+  $logger.debug "command: #{command}"
+  machine.ssh(command)
+end

data/standard/linux/commands/current_user.rb

@@ -0,0 +1,5 @@
+param! :machine
+
+run do |machine|
+  machine.ssh("whoami").strip
+end

data/standard/linux/commands/distro.rb

@@ -2,13 +2,14 @@ description "tries to return a meaningful string for the linux distribution runn
 
 param! :machine
 
-# TODO mark_as_read_only
+read_only
 
 run do |machine, params|
   input = machine.ssh("cat /etc/issue")
 
   input.strip!
   first_line = input.split("\n").first
+
   result = 'unknown'
   if (matched = /SUSE\s+Linux\s+Enterprise\s+Server\s(\d+)\s+(SP\d+)?/.match(first_line))
     result = 'sles_' + matched.captures[0] + ' ' + matched.captures[1]

data/standard/linux/commands/download_file.rb

@@ -1,17 +1,17 @@
-param! 'machine'
-param! 'url'
-param! 'file'
+param! :machine
+param! "url"
+param! "file"
 
 run do |machine, url, file|
   has_curl = machine.ssh("which curl")
 
-  puts "has_curl: #{has_curl}"
+  $logger.debug "has_curl: #{has_curl}"
   raise "no curl" unless has_curl
 
   command = "curl --silent --location"
   command += " --create-dirs -o #{file}"
-  command += " #{url}"
+  command += " '#{url}'"
 
-  puts "command: #{command}"
+  $logger.debug "command: #{command}"
   machine.ssh(command)
 end

data/standard/linux/commands/external_ip.rb

@@ -0,0 +1,15 @@
+param! :machine
+param "internal_prefix", default: "192.168"
+
+run do |machine, internal_prefix|
+  unless internal_prefix.end_with? "."
+    internal_prefix += "."
+  end
+  escaped_prefix = internal_prefix.gsub!(".", "\\.")
+
+  # TODO make ipv4 vs ipv6 configurable
+  input = machine.ssh("ip addr | grep -v '#{internal_prefix}' | grep inet | grep -v inet6 | grep -v '127.0.0.1'")
+  if input =~ /inet\s+([\d\.]+)(?:\/(\d+))?/
+    $1
+  end
+end

data/standard/linux/commands/file_exists.rb

@@ -0,0 +1,7 @@
+param! :machine
+param! "path", default_param: true
+
+run do |machine, path|
+  result = machine.ssh_extended("ls -1 #{path}")
+  result["result_code"].to_i == 0
+end

data/standard/linux/commands/home.rb

@@ -0,0 +1,7 @@
+description "returns the currently logged in user's home directory (i.e. $HOME)"
+
+param :machine, default_param: true
+
+run do |machine|
+  machine.ssh("echo $HOME").strip
+end

data/standard/linux/commands/hostname.rb

@@ -0,0 +1,5 @@
+param! :machine
+
+run do |machine|
+  machine.ssh("hostname -f").strip
+end

data/standard/linux/commands/internal_ip.rb

@@ -0,0 +1,14 @@
+param! :machine
+param "prefix", default: "192.168"
+
+run do |machine, prefix|
+  unless prefix.end_with? "."
+    prefix += "."
+  end
+  escaped_prefix = prefix.gsub!(".", "\\.")
+  # TODO we could have more than one internal IP, right?
+  input = machine.ssh("ip addr | grep #{prefix}")
+  if input =~ /inet\s+(#{prefix}\d+\.\d+)/
+    $1
+  end
+end

data/standard/linux/commands/ipaddress.rb

@@ -0,0 +1,10 @@
+description "returns the host's ip addresses (currently this means eth0)"
+
+param! :machine
+param "interface", description: "name of the interface", default_value: "eth0"
+
+read_only
+
+run do |machine, params|
+  machine.list_ip_addresses('device' => params['interface']).first["address"]
+end

data/standard/linux/commands/list_files.rb

@@ -1,17 +1,19 @@
-param! 'machine'
-param! 'dir'
+param! :machine
+param! "dir", default_param: true
 
-show columns: %i|name owner group permissions size timestamp|
+read_only
+
+show columns: %w|name owner group permissions size timestamp|
 
 run do |machine, dir|
   ssh_regex(machine, "ls -l --full-time #{dir}",
     # drwxrwxr-x   3  philipp philipp 4096    2016-01-16 04:16:24.621111156 +0100 lib
     /(\S+)\s+(\d+)\s+(\S+)\s+(\S+)\s+(\d+)\s+([\d-]+)\s+([\d:]+)\.\d+\s+(\+\d+)\s+(.+)$/,
-    %i|permissions links owner group size date time time_zone name|,
+    %w|permissions links owner group size date time time_zone name|,
     {
       :post_process => lambda { |parsed|
-        date, time, zone = parsed.delete(:date), parsed.delete(:time), parsed.delete(:time_zone)
-        parsed[:timestamp] = "#{date} #{time} #{zone}"
+        date, time, zone = parsed.delete("date"), parsed.delete("time"), parsed.delete("time_zone")
+        parsed["timestamp"] = "#{date} #{time} #{zone}"
         parsed
       }
     }

data/standard/linux/commands/list_ip_addresses.rb

@@ -0,0 +1,22 @@
+param :machine
+param "device"
+param "filter"
+
+show columns: [ :address, :netmask ]
+
+run do |machine, params|
+  dev_filter = params.has_key?("device") ? "show #{params["device"]}" : ''
+
+  result = []
+  lines = machine.sudo("ip addr #{dev_filter}").split("\n")
+  lines.each do |line|
+    line.chomp! and line.strip!
+    # TODO handle inet6
+    next unless matched = /inet\s([\d\.]+)(?:\/(\d+))?/.match(line)
+    result << {
+      "address" => $1,
+      "netmask" => $2
+    }
+  end
+  result
+end

data/standard/linux/commands/listen_ports.rb

@@ -1,7 +1,8 @@
-param! 'machine'
+param! :machine
 
 run do |machine|
-  input = machine.ssh("ss -tnl")
+  # TODO might need sudo
+  input = machine.ssh("ss -tnlp")
 
   result = Hash.new { |h,k| h[k] = [] }
 

data/standard/linux/commands/maybe_sudo.rb

@@ -0,0 +1,8 @@
+param! :machine
+param! "cmd"
+
+run do |machine, cmd|
+  raise "kaboom"
+  maybe_sudo = machine.current_user == "root" ? "" : "sudo "
+  machine.ssh "#{maybe_sudo}#{cmd}"
+end

data/standard/linux/commands/mkdirs.rb

@@ -0,0 +1,12 @@
+param! :machine
+param! "dir", default_param: true
+param "permissions"
+
+run do |machine, dir, permissions|
+  command = "mkdir -p"
+  if permissions
+    command += " -m #{permissions}"
+  end
+  command += " #{dir}"
+  machine.ssh(command)
+end

data/standard/linux/commands/processes.rb

@@ -1,6 +1,8 @@
-param! "machine"
+param! :machine
 
-show columns: %i|pid command_short|
+show columns: %w|pid command_short|
+
+read_only
 
 run do |params, machine|
   input = machine.ssh("ps aux")
@@ -10,10 +12,10 @@ run do |params, machine|
     (user, pid, cpu, mem, vsz, rss, tty, stat, start, time) = parts[0..9]
     command = parts[10..parts.length-1].join(" ")
     {
-      pid: pid,
-      command: command,
-      command_short: command[0..119],
-      user: user
+      "pid" => pid,
+      "command" => command,
+      "command_short" => command[0..79],
+      "user" => user
     }
   end
 end

data/standard/linux/commands/processes_like.rb

@@ -1,11 +1,11 @@
-param! "machine"
-param! "expression", :default_param => true
+param! :machine
+param! "regex", default_param: true
 
-show columns: %i|pid command_short|
+show columns: %w|pid command|
 
-run do |params, expression|
-  column_name = :command_short
-  @op.processes(params).select do |item|
-    item[column_name] =~ Regexp.new(expression)
+run do |machine, regex|
+  the_regex = /#{Regexp.escape(regex)}/
+  machine.processes.select do |process|
+    the_regex.match(process["command"])
   end
 end

data/standard/linux/commands/processes_top.rb

@@ -0,0 +1,23 @@
+param! :machine
+param! "sort_column"
+param "count", default: 10
+
+show sort: false
+
+run do |machine, sort_column, count|
+  result = ssh_regex(machine, "ps -eo pid,args,%cpu,%mem --sort -#{sort_column}",
+    # PID         COMMAND  %CPU      %MEM
+    # 2572        ng       60.4      12.1
+    /^\s*(\d+)\s+(.+)\s+([\d\.]+)\s+([\d\.]+)$/,
+    %w|pid command cpu mem|
+  )
+
+  # TODO would be nifty to auto-detect numbers (then we wouldn't have to .to_i here)
+  count = count.to_i
+  if count > 0
+    last_idx = count -1
+    result = result[0..last_idx]
+  end
+
+  result
+end

data/standard/linux/commands/processes_top_cpu.rb

@@ -0,0 +1,8 @@
+param! :machine
+param "count", default: 10
+
+show sort: false
+
+run do |params|
+  @op.processes_top(params.merge("sort_column" => "%cpu"))
+end

data/standard/linux/commands/processes_top_mem.rb

@@ -0,0 +1,8 @@
+param! :machine
+param "count", default: 10
+
+show sort: false
+
+run do |params|
+  @op.processes_top(params.merge("sort_column" => "%mem"))
+end

data/standard/linux/commands/read_file.rb

@@ -1,6 +1,11 @@
 param! :machine
-param! "file"
+param! "file", default_param: true
+
+read_only
 
 run do |machine, file|
-  machine.ssh("cat #{file}")
+  if file.nil? || file == ""
+    raise "no file name"
+  end
+  machine.ssh "cat #{file}"
 end

data/standard/linux/commands/replace_in_file.rb

@@ -0,0 +1,22 @@
+description "calls 'sed' to replace a pattern in a file. see man sed"
+
+param :machine
+param! "file_name", "the file to work with"
+param! "source", "the source pattern that should be replaced"
+param! "target", "the replacement string"
+param "sudo", default: false
+
+run do |machine, params, sudo|
+  source = params["source"].gsub('/', '\/')
+  target = params["target"].gsub('/', '\/')
+  sed_cmd = "sed -i -e 's/#{source}/#{target}/g' #{params["file_name"]}"
+  if sudo
+    machine.sudo sed_cmd
+  else
+    machine.ssh sed_cmd
+  end
+  # TODO this hangs when sudo=true
+  unless sudo
+    machine.read_file! params["file_name"]
+  end
+end

data/standard/linux/commands/set_hostname.rb

@@ -0,0 +1,36 @@
+param! :machine
+param! "new_name", default_param: true
+param "new_domain", default: "local"
+
+run do |machine, new_name, new_domain|
+  full_name = "#{new_name}.#{new_domain}"
+
+  current = machine.hostname
+  if current == full_name
+    $logger.info "hostname already #{current}, skipping"
+  else
+    machine.sudo "hostname #{full_name}"
+
+    # TODO this might be setup-specific, extract?
+    meta = machine.metadata
+    new_entry = "#{full_name} #{new_name}"
+    if meta["type"] == "host"
+      machine.update_hosts_file(
+        ip: machine.external_ip,
+        content: new_entry
+      )
+    elsif meta["type"] == "vm"
+      machine.update_hosts_file(
+        ip: "127.0.1.1",
+        content: new_entry
+      )
+    end
+
+    # update /etc/hostname
+    machine.write_file(
+      "file_name" => "/etc/hostname",
+      "content" => new_name,
+      "sudo" => true
+    )
+  end
+end