takelage 0.1.0

data/lib/takelage/docker/container/check/module.rb

@@ -0,0 +1,44 @@
+# takelage docker container check module
+module DockerContainerCheckModule
+
+  # Backend method for docker container check existing.
+  # @return [Boolean] is container existing?
+  def docker_container_check_existing(container)
+    log.debug "Checking if container \"#{container}\" is existing"
+
+    cmd_docker_existing = 'docker ps ' +
+        "--filter name=^#{container}$ " +
+        '--quiet'
+
+    stdout_str, stderr_str, status = run_and_check cmd_docker_existing
+
+    if stdout_str.to_s.strip.empty?
+      log.debug "Container \"#{container}\" is not existing"
+      return false
+    end
+
+    log.debug "Container \"#{container}\" is existing"
+    true
+  end
+
+  # Backend method for docker container check orphaned.
+  # @return [Boolean] is container orphaned?
+  def docker_container_check_orphaned(container)
+    log.debug "Check if container \"#{container}\" is orphaned"
+
+    cmd_docker_orphaned = 'docker exec ' +
+        '--interactive ' +
+        "#{container} " +
+        'ps a'
+
+    stdout_str, stderr_str, status = run_and_check cmd_docker_orphaned
+
+    if stdout_str.include? '/loginpoint.py'
+      log.debug "Container \"#{container}\" isn't orphaned"
+      return false
+    end
+
+    log.debug "Container \"#{container}\" is orphaned"
+    true
+  end
+end

data/lib/takelage/docker/container/cli.rb

@@ -0,0 +1,127 @@
+module Takelage
+
+  # takelage docker container
+  class DockerContainer < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerContainerCheckModule
+    include DockerContainerModule
+    include DockerImageTagLatestModule
+    include DockerImageTagListModule
+    include DockerImageTagCheckModule
+    include DockerSocketModule
+
+    # Initialize takelage docker container
+    def initialize(args=[], local_options={}, configuration={})
+
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @docker_image = config.active['docker_image']
+      @docker_tag = config.active['docker_tag']
+
+      @dockersock = '/var/run/docker.sock'
+
+      @username = ENV['USER'] ? ENV['USER'] : 'username'
+      @gid = Etc.getpwnam(@username).gid
+      @uid = Etc.getpwnam(@username).uid
+
+      @homedir = ENV['HOME'] ? ENV['HOME'] : ''
+      @workdir = Dir.getwd
+      @hostname = "#{@docker_image}_#{File.basename(@workdir)}"
+
+      @hostsystem = 'macos'
+      @timezone = 'Europe/Berlin'
+
+      @sockets = {
+          :'agent-socket' => {
+              :path => nil,
+              :host => '127.0.0.1',
+              :port => config.active['docker_socket_agent_port']},
+          :'agent-ssh-socket' => {
+              :path => nil,
+              :host => '127.0.0.1',
+              :port => config.active['docker_socket_agent_ssh_port']},
+          :'agent-extra-socket' => {
+              :path => nil,
+              :host => '127.0.0.1',
+              :port => config.active['docker_socket_agent_extra_port']},
+          :'agent-browser-socket' => {
+              :path => nil,
+              :host => '127.0.0.1',
+              :port => config.active['docker_socket_agent_browser_port']}}
+      _get_socket_paths
+    end
+
+    desc 'check [COMMAND]', 'Check docker container'
+    subcommand 'check', DockerContainerCheck
+
+    #
+    # docker container daemon
+    #
+    desc 'daemon', 'Run docker container in daemon mode'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run docker container in daemon mode
+    LONGDESC
+    # Run docker container in daemon mode.
+    def daemon
+      docker_container_daemon
+    end
+
+    #
+    # docker container login
+    #
+    option :development,
+           :aliases => 'd',
+           :type => :boolean,
+           :default => false,
+           :desc => 'Log in to docker container in debug mode'
+    desc 'login', 'Log in to latest local docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Log in to latest local docker container
+    LONGDESC
+    # Log in to latest local docker container.
+    def login
+      docker_container_login
+    end
+
+    #
+    # docker container nuke
+    #
+    desc 'nuke', 'Remove all docker containers'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Remove all docker containers
+    LONGDESC
+    # Remove all docker containers.
+    def nuke
+      docker_container_nuke
+    end
+
+    #
+    # docker container purge
+    #
+    desc 'purge', 'Remove orphaned docker containers'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Remove orphaned docker containers
+    LONGDESC
+    # Remove orphaned docker containers.
+    def purge
+      docker_container_purge
+    end
+
+    #
+    # docker container run
+    #
+    desc 'command [CMD]', 'Run [CMD] in a docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run command in docker container
+    LONGDESC
+    # Run command in docker container.
+    def command(command)
+      docker_container_command(command)
+    end
+  end
+end

data/lib/takelage/docker/container/module.rb

@@ -0,0 +1,168 @@
+# takelage docker container module
+module DockerContainerModule
+
+  # Backend method for docker container run.
+  def docker_container_command(command)
+    log.debug "Running command in container"
+
+    exit false unless configured? %w(docker_repo docker_image docker_tag)
+
+    docker_socket_start
+
+    _create_container @hostname unless docker_container_check_existing @hostname
+    _run_command_in_container @hostname, command
+  end
+
+  # Backend method for docker container daemon.
+  def docker_container_daemon
+    log.debug 'Starting docker container as daemon'
+
+    exit false unless configured? %w(docker_repo docker_image docker_tag)
+
+    _create_container @hostname unless docker_container_check_existing @hostname
+  end
+
+  # Backend method for docker container login.
+  def docker_container_login
+    log.debug 'Logging in to docker container'
+
+    exit false unless configured? %w(docker_repo docker_image docker_tag)
+
+    docker_socket_start
+
+    _create_container @hostname unless docker_container_check_existing @hostname
+    _enter_container @hostname
+  end
+
+  # Backend method for docker container nuke.
+  def docker_container_nuke
+    log.debug 'Removing all docker containers'
+
+    exit false unless configured? %w(docker_image)
+
+    _get_containers.each do |container|
+      _stop_container container
+    end
+  end
+
+  # Backend method for docker container purge.
+  def docker_container_purge
+    log.debug 'Removing orphaned docker containers'
+
+    exit false unless configured? %w(docker_image)
+
+    _get_containers.each do |container|
+      _stop_container container if docker_container_check_orphaned container
+    end
+  end
+
+  # Create docker container.
+  def _create_container(container)
+    log.debug "Creating container \"#{container}\""
+
+    if @docker_tag == 'latest'
+      tag = docker_image_tag_latest_local
+    else
+      tag = @docker_tag
+    end
+
+    image = "#{@docker_repo}/#{@docker_image}:#{tag}"
+
+    log.debug "Using docker image \"#{image}\""
+
+    unless docker_image_tag_check_local tag
+      log.error "Image \"#{image}\" does not exist"
+      exit false
+    end
+
+    entrypoint = '/entrypoint.py '
+    volume_dev = ''
+    if options[:development]
+      entrypoint = '/debug/entrypoint.py --debug '
+      volume_dev = "--volume #{@workdir}/ansible/roles/geospin-ansible-devel/files:/debug "
+    end
+
+    cmd_docker_create = 'docker run ' +
+        '--detach ' +
+        "--env GEOSPIN_PROJECT_BASE_DIR=#{@workdir} " +
+        '--env GOOGLE_APPLICATION_CREDENTIALS=/srv/google/default.json ' +
+        "--env TZ=#{@timezone} " +
+        "--hostname #{container} " +
+        "--name #{container} " +
+        '--privileged ' +
+        '--rm ' +
+        '--tty ' +
+        "--volume #{@dockersock}:/var/run/docker.sock " +
+        "--volume #{@homedir}/.config/gcloud:/srv/gcloud " +
+        "--volume #{@homedir}/.google:/srv/google " +
+        "--volume #{@homedir}:/homedir " +
+        "--volume #{@workdir}:/project " +
+        volume_dev +
+        '--workdir /project ' +
+        "#{image} " +
+        entrypoint +
+        "--gid #{@gid} " +
+        "--hostsystem #{@hostsystem} " +
+        "--uid #{@uid} " +
+        "--username #{@username}"
+
+    run cmd_docker_create
+  end
+
+  # Enter existing docker container.
+  def _enter_container(container)
+    log.debug "Entering container \"#{container}\""
+
+    loginpoint = '/loginpoint.py '
+    if options[:development]
+      loginpoint = '/loginpoint.py --debug '
+    end
+
+    cmd_docker_enter = 'docker exec ' +
+        '--interactive ' +
+        '--tty ' +
+        "#{container} " +
+        loginpoint +
+        "--username #{@username}"
+
+    run_and_exit cmd_docker_enter
+  end
+
+  # Get all docker containers.
+  # @return [Array] list of docker containers
+  def _get_containers
+    log.debug "Getting all #{@docker_image} containers"
+
+    cmd_docker_get = 'docker ps ' +
+        '--all ' +
+        "--filter name=^#{@docker_image}_ " +
+        '--quiet'
+
+    stdout_str, stderr_str, status = run_and_check cmd_docker_get
+
+    # convert stdout lines to array and return array
+    stdout_str.split(/\n+/)
+  end
+
+  # Remove container.
+  def _stop_container(container)
+    log.debug "Stopping container \"#{container}\""
+
+    cmd_docker_stop = 'docker stop ' +
+        "#{container}"
+
+    run cmd_docker_stop
+  end
+
+  # Enter existing docker container.
+  def _run_command_in_container(container, command)
+    log.debug "Running command \"#{command}\" in container \"#{container}\""
+
+    cmd_docker_run_command = 'docker exec ' +
+        "#{container} " +
+        "su #{@username} " +
+        "-c 'LANG=en_US.UTF-8 #{command}'"
+
+    run_and_exit cmd_docker_run_command
+  end
+end

data/lib/takelage/docker/image/cli.rb

@@ -0,0 +1,41 @@
+module Takelage
+
+  # takelage docker image
+  class DockerImage < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerImageTagListModule
+    include DockerImageTagLatestModule
+    include DockerImageModule
+
+    # Initialize takelage docker image
+    def initialize(args=[], local_options={}, configuration={})
+
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @docker_image = config.active['docker_image']
+      @docker_tagsurl = config.active['docker_tagsurl']
+    end
+
+    desc 'tag [COMMAND]', 'Handle docker image tags'
+    subcommand 'tag', DockerImageTag
+
+    #
+    # docker image update
+    #
+    desc 'update', 'Get latest remote docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Get latest remote docker container
+    This command will download the latest remote version of the takelage docker container.
+    When you start the environment the latest locally available container will be used.
+    LONGDESC
+    # Get latest remote docker container.
+    def update
+      docker_image_update
+    end
+  end
+end

data/lib/takelage/docker/image/module.rb

@@ -0,0 +1,33 @@
+# takelage docker image module
+module DockerImageModule
+
+  # Backend method for docker image update.
+  def docker_image_update
+    exit false unless configured? %w(docker_repo docker_image docker_tagsurl)
+
+    tag_latest_local = docker_image_tag_latest_local
+
+    if tag_latest_local.to_s.strip.empty?
+      log.error "Unable to get latest local tag"
+      exit false
+    end
+
+    tag_latest_remote = docker_image_tag_latest_remote
+
+    if tag_latest_remote.to_s.strip.empty?
+      log.error "Unable to get latest remote tag"
+      exit false
+    end
+
+    if Gem::Version.new(tag_latest_local) >= Gem::Version.new(tag_latest_remote)
+      log.info 'Already up to date.'
+      exit
+    end
+
+    cmd_docker_pull_latest = "docker pull #{@docker_repo}/#{@docker_image}:#{tag_latest_remote}"
+
+    log.info "Updating to docker image \"#{@docker_repo}/#{@docker_image}:#{tag_latest_remote}\""
+
+    run_and_exit cmd_docker_pull_latest
+  end
+end

data/lib/takelage/docker/image/tag/check/cli.rb

@@ -0,0 +1,47 @@
+module Takelage
+
+  # takelage docker image tag check
+  class DockerImageTagCheck < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerImageTagListModule
+    include DockerImageTagCheckModule
+
+    # Initialize takelage docker image tag check
+    def initialize(args = [], local_options = {}, configuration = {})
+
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @docker_image = config.active['docker_image']
+      @docker_tagsurl = config.active['docker_tagsurl']
+    end
+
+    #
+    # docker image tag check local
+    #
+    desc 'local [TAG]', 'Check if local docker image [TAG] exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if local docker image tag exists
+    LONGDESC
+    # Check if local docker image tag exists.
+    def local(tag)
+      exit docker_image_tag_check_local tag
+    end
+
+    #
+    # docker image tag check remote
+    #
+    desc 'remote [TAG]', 'Check if remote docker image [TAG] exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if remote docker image tag exists
+    LONGDESC
+    # Check if remote docker image tag exists.
+    def remote(tag)
+      exit docker_image_tag_check_remote tag
+    end
+  end
+end

data/lib/takelage/docker/image/tag/check/module.rb

@@ -0,0 +1,56 @@
+# takelage docker image tag check module
+module DockerImageTagCheckModule
+
+  # Backend method for docker image check tag local.
+  # @return [Boolean] does local docker image tag exist?
+  def docker_image_tag_check_local(tag)
+    log.debug "Check if local docker image tag \"#{tag}\" exists"
+
+    exit false unless configured? %w(docker_repo docker_image)
+
+    if tag.to_s.strip.empty?
+      log.warn "No local docker image tag specified"
+      return false
+    end
+
+    image = "#{@docker_repo}/#{@docker_image}:#{tag}"
+
+    cmd_docker_images = 'docker images --quiet ' +
+        image
+
+    stdout_str, stderr_str, status = run_and_check cmd_docker_images
+
+    if stdout_str.to_s.strip.empty?
+      log.debug "No local docker image \"#{image}\" found"
+      return false
+    end
+
+    log.debug "Found local docker image \"#{image}\""
+    true
+  end
+
+  # Backend method for docker image check tag remote.
+  # @return [Boolean] does remote docker image tag exist?
+  def docker_image_tag_check_remote(tag)
+    log.debug "Check if remote image tag \"#{tag}\" exists"
+
+    exit false unless configured? %w(docker_repo docker_image docker_tagsurl)
+
+    if tag .to_s.strip.empty?
+      log.warn "No remote docker image tag specified"
+      return false
+    end
+
+    image = "#{@docker_repo}/#{@docker_image}:#{tag}"
+
+    tags = docker_image_tag_list_remote
+
+    unless tags.include? tag
+      log.debug "No remote docker image \"#{image}\" found"
+      return false
+    end
+
+    log.debug "Found remote docker image \"#{image}\""
+    true
+  end
+end

data/lib/takelage/docker/image/tag/cli.rb

@@ -0,0 +1,16 @@
+module Takelage
+
+  # takelage docker image tag
+  class DockerImageTag < SubCommandBase
+
+    desc 'check [COMMAND]', 'Check docker image tag'
+    subcommand 'check', DockerImageTagCheck
+
+    desc 'latest [COMMAND]', 'Print latest local or remote docker image tag'
+    subcommand 'latest', DockerImageTagLatest
+
+    desc 'list [COMMAND]', 'Print local or remote docker image tags'
+    subcommand 'list', DockerImageTagList
+
+  end
+end

data/lib/takelage/docker/image/tag/latest/cli.rb

@@ -0,0 +1,49 @@
+module Takelage
+
+  # takelage docker image tag latest
+  class DockerImageTagLatest < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerImageTagListModule
+    include DockerImageTagLatestModule
+
+    # Initialize takelage docker image tag latest
+    def initialize(args = [], local_options = {}, configuration = {})
+
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @docker_image = config.active['docker_image']
+      @docker_tagsurl = config.active['docker_tagsurl']
+    end
+
+    #
+    # docker image tag latest local
+    #
+    desc 'local', 'Print latest local docker image tag'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print latest local docker image tag
+    Print the tag of the local docker image with the highest tag.
+    LONGDESC
+    # Print latest local docker image tag.
+    def local
+      say docker_image_tag_latest_local
+    end
+
+    #
+    # docker image tag latest remote
+    #
+    desc 'remote', 'Print latest remote docker image tag'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print latest remote docker image tag
+    Print the tag of the remote docker image with the highest tag.
+    LONGDESC
+    # Print latest remote docker image tag.
+    def remote
+      say docker_image_tag_latest_remote
+    end
+  end
+end

data/lib/takelage/docker/image/tag/latest/module.rb

@@ -0,0 +1,31 @@
+# takelage docker image tag latest module
+module DockerImageTagLatestModule
+
+  # Backend method for docker image tag latest local.
+  # @return [String] latest local docker image tag
+  def docker_image_tag_latest_local
+    log.debug "Getting latest local docker image tag"
+
+    tags = docker_image_tag_list_local
+
+    tag_latest_local = tags[-1]
+
+    log.debug "Latest docker local tag: #{tag_latest_local}"
+
+    tag_latest_local
+  end
+
+  # Backend method for docker image tag latest remote.
+  # @return [String] latest remote docker image tag
+  def docker_image_tag_latest_remote
+    log.debug "Getting latest remote docker image tag"
+
+    tags = docker_image_tag_list_remote
+
+    tag_latest_remote = tags[-1]
+
+    log.debug "Latest docker remote tag: #{tag_latest_remote}"
+
+    tag_latest_remote
+  end
+end

data/lib/takelage/docker/image/tag/list/cli.rb

@@ -0,0 +1,46 @@
+module Takelage
+
+  # takelage docker image tag list
+  class DockerImageTagList < SubCommandBase
+
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerImageTagListModule
+
+    # Initialize takelage docker image tag list
+    def initialize(args = [], local_options = {}, configuration = {})
+
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @docker_image = config.active['docker_image']
+      @docker_tagsurl = config.active['docker_tagsurl']
+    end
+
+    #
+    # docker image tag list local
+    #
+    desc 'local', 'Print local docker image tags'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print local docker image tags
+    LONGDESC
+    # Print local docker image tags.
+    def local
+      say docker_image_tag_list_local
+    end
+
+    #
+    # docker image tag list remote
+    #
+    desc 'remote', 'Print remote docker image tags'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print remote docker image tags
+    LONGDESC
+    # Print latest remote docker image tag.
+    def remote
+      say docker_image_tag_list_remote
+    end
+  end
+end