panoramix 0.5.0

data/lib/panoramix/plugin/base.rb

@@ -0,0 +1,47 @@
+require "panoramix/locale"
+
+module Panoramix
+	module Plugin
+
+		class ValidationError < StandardError; end
+
+		class Base
+
+			def initialize host
+				@host = host
+			end
+
+			# Return current timestamp
+			def timestamp
+				raise "Not implemented"
+			end
+
+			# When this instance needs to be executed
+			def needed? timestamps
+				raise "Not implemented"
+			end
+
+			# Has this instance already been created
+			def created?
+				raise "Not implemented"
+			end
+
+			# Default action for this task
+			def run_default
+				raise "Not implemented"
+			end
+
+			def shell(cmd, silent=false, env=Hash.new)
+				# Get a connection for the current host
+				connection = Panoramix.connection(@host)
+				# Run the shell command
+				connection.shell(cmd, silent, env)
+			end
+
+			def shell_ready?
+				Panoramix.connection(@host).ready?
+			end
+
+		end
+	end
+end

data/lib/panoramix/plugin/docker_build.rb

@@ -0,0 +1,83 @@
+require "panoramix/plugin/docker_image_base"
+
+module Panoramix
+  module Plugin
+
+    class DockerBuild < DockerImageBase
+
+      attr_reader :src
+
+      def initialize(dst, src, host)
+        super(dst, host)
+        @src = src
+      end
+
+      # When this instance needs to be executed
+      def needed? timestamps
+        return false if ENV['NO_BUILD'].split(":").any? { |image| image == @dst }
+        this_time = timestamp
+        timestamps.any? { |t| t > this_time }
+      end
+
+      # Default action for this task
+      def run_default
+        shell "docker build -t #{dst} #{File.dirname(@src)}"
+      end
+
+      def ps
+        super ("Built image")
+      end
+
+      def validate
+      end
+
+    end
+
+  end
+end
+
+def docker_image(args, block=nil)
+
+  puts "Warning using obsolete docker_image
+    \t => #{"docker_image".bold} <image_name> => {dockerfile: <path_dockerfile>}.\n\tchange to:
+    \t => #{"docker_build".bold} <image_name> => {dockerfile: <path_dockerfile>}".red
+  docker_build(args, block)
+end
+
+def docker_build(args, &block)
+  # Get task name
+  name = args.keys[0]
+
+  # Get configuration hash
+  config = args[name].select { |dep| dep.is_a? Hash }.first
+
+  # Get dockerfile if given
+  dockerfile = config.fetch(:dockerfile, nil)
+
+  # Raise error if :dockerfile value is nil
+  unless dockerfile
+    message = I18n.t('errors.docker_build.no_dockerfile_provided')
+    raise message
+  end
+
+  # Select provided dependencies
+  prerequisites = args[name].select { |d| ! d.is_a? Hash }
+
+  # Merge prerequisites with the Dockerfile file_task
+  prerequisites = prerequisites.push(dockerfile) unless dockerfile.nil?
+
+  # Set host as a new prerequisite if needed
+  host_dep = Panoramix.resolve_host_dependencies
+  prerequisites = prerequisites.push(host_dep) unless host_dep.nil?
+  prerequisites.flatten!
+
+  # Get hostname for this scope
+  host = Panoramix.current_host_name
+
+  instance = Panoramix::Plugin::DockerBuild.new(name, dockerfile, host)
+
+  descriptions = I18n.t('docker_build')
+  descriptions = Hash.new if descriptions.class != Hash
+
+  Panoramix.define_tasks(name,descriptions, instance, prerequisites, block)
+end

data/lib/panoramix/plugin/docker_image.rb

@@ -0,0 +1,67 @@
+require "panoramix/plugin/docker_image_base"
+
+module Panoramix
+	module Plugin
+
+		class DockerImage < DockerImageBase
+
+			attr_reader :src
+
+			def initialize(dst, src, host)
+				super(dst, host)
+				@src = src
+			end
+
+			# When this instance needs to be executed
+			def needed? timestamps
+				true
+			end
+
+			# Action clobber for this task
+			def clobber
+				super
+				info = created?
+        if info
+          id = info.split(" ")[2]
+          shell "docker rmi -f #{id}"
+        end
+			end
+
+			# Default action for this task
+			def run_default
+				shell "docker pull #{@src}" unless ENV["NO_PULL"]
+
+				# Tag image with required tag
+				shell "docker tag -f #{@src} #{@dst}"
+			end
+
+			def ps
+				super ("Pulled image")
+			end
+
+		end
+
+	end
+end
+
+
+def external_docker_image(args, block)
+	name = args.keys[0]
+	src = args[name][:dockerimage] || args[name][:docker]
+
+	prerequisites = []
+
+	# Set host as a new prerequisite if needed
+	host_dep = Panoramix.resolve_host_dependencies
+	prerequisites = prerequisites.push(host_dep) unless host_dep.nil?
+
+	# Get hostname for this scope
+	host = Panoramix.current_host_name
+
+	instance = Panoramix::Plugin::DockerImage.new(name, src, host)
+
+	descriptions = I18n.t('docker_image')
+	descriptions = Hash.new if descriptions.class != Hash
+
+	Panoramix.define_tasks(name, descriptions, instance, prerequisites, block)
+end

data/lib/panoramix/plugin/docker_image_base.rb

@@ -0,0 +1,61 @@
+require "time"
+require "panoramix/plugin/base"
+
+module Panoramix
+  module Plugin
+
+    class DockerImageBase < Base
+
+      attr_reader :dst
+
+      def initialize(dst, host)
+        super host
+        @dst = dst
+        @tag = "latest"
+      end
+
+      # Return timestamp of the image
+      def timestamp
+        info =  created?
+        if info
+          # Get image timestamp
+          id = info.split(" ")[2]
+          time = shell("docker inspect -f {{.Created}} #{id}", true)[:out]
+          return Time.parse(time)
+        else
+          return Time.at 0
+        end
+      end
+
+      # Has this image already been created
+      def created?
+        return @created if @created
+        return nil unless shell_ready?
+        info = shell("docker images | grep -w '^#{@dst}' | grep -w '#{@tag}'", true)[:out]
+        @created = info = info.empty? ? nil: info
+      end
+
+      # Action clobber for this task
+      def clobber
+        info = created?
+        if info
+          id = info.split(" ")[2]
+          shell "docker rmi -f #{id}"
+        end 
+      end
+
+      def ps(message)
+        puts "#{message}: #{@dst}"
+        info = created?
+        if info
+          puts "Timestamp: #{timestamp}"
+          puts info
+        else
+          puts "Timestamp: Not created"
+        end
+        puts
+      end
+
+    end
+  end
+end

data/lib/panoramix/plugin/docker_up.rb

@@ -0,0 +1,178 @@
+require "time"
+require "panoramix/plugin/base"
+
+module Panoramix
+	module Plugin
+
+		class DockerUpExceptionError < StandardError; end
+
+		class DockerUp < Base
+
+			attr_reader :dst
+			attr_reader :src
+			attr_reader :env
+
+			def initialize(dst, src, env, host)
+				super (host)
+				@dst = dst
+				@src = src
+				@env = env
+			end
+
+			# Return current timestamp for the container
+			def timestamp
+				info = created?
+				if info
+					id = info.split("\n").first
+					time = shell("docker inspect -f {{.Created}} #{id}", true, @env)[:out]
+					return Time.parse(time)
+			  else
+			  	Time.at 0
+			  end
+			end
+
+			# Has this image already been created
+			def created?
+				return nil unless shell_ready?
+				info = shell("docker-compose -p #{@dst} -f #{@src} ps -q", true, @env)[:out]
+				@created = info = info.empty? ? nil: info
+			end
+
+			# Action clobber for this task
+			def clobber
+				shell("docker-compose -p #{@dst} -f #{@src} kill; docker-compose -p #{@dst} -f #{@src} rm -v --force", false, @env) if created?
+			end
+
+			# When this instance needs to be executed
+			def needed? timestamps
+				this_time = timestamp
+				timestamps.any? { |t| t > this_time }
+			end
+
+			# Default action for this task
+			def run_default
+				@env = parse_env @env.keys
+				# Raise an exception if already has been created
+				if created?
+					message = I18n.t('errors.docker_up.cluster_deployed', {:id => @dst})
+					raise(DockerUpExceptionError, message)
+				end
+	      # Run docker-compose up otherwise
+		    shell("docker-compose -p #{dst} -f #{@src}  up -d", false, @env)
+		  end
+
+			def stop
+				if created?
+					shell("docker-compose -p #{dst} -f #{@src} stop", false, @env)
+				end
+			end
+
+			def start
+				if created?
+					shell("docker-compose -p #{dst} -f #{@src}  up -d", false, @env)
+				end
+			end
+
+		  # Print docker-compose project logs
+	    def logs
+				info = created?
+				if info
+					containers = info.split("\n")
+					colors = ['red', 'green','brown','blue','magenta','cyan']
+					containers.each do |c|
+						out = shell("docker logs #{c} | tail -n 200", true, @env)
+						name = shell("docker inspect -f {{.Name}} #{c}", true, @env)[:out]
+						name.gsub!("\n", "")
+						name.gsub!("/", "")
+						name = eval %& "#{name} >".#{colors.first}&
+						colors.push colors.shift
+						out[:out].split("\n").each{ |out| puts name + out }
+						out[:err].split("\n").each{ |out| puts name + out }
+					end
+				end
+	    end
+
+	    # Print docker-compose ps
+	    def ps
+	    	puts "Service: #{@dst}"
+				if created?
+          puts "Timestamp: #{timestamp}"
+          info = shell("docker-compose -p #{@dst} -f #{@src} ps", true, @env)[:out]
+		    	puts info
+				else
+					puts "Timestamp: Not created"
+				end
+				puts
+	    end
+
+			def validate
+				keys_errors = ""
+				@env.each do |key, value|
+					if value.nil?
+						keys_errors << "#{key} " if Panoramix::Link[key].nil?
+					end
+				end
+
+				if keys_errors != ""
+					message = I18n.t('errors.docker_up.env_var_not_given', {:env => keys_errors})
+					raise(ValidationError, message)
+				end
+			end
+
+		end
+
+	end
+end
+
+
+def parse_env environment
+  res=Hash.new
+
+  #TODO: chech if some env variable is a link
+  environment.each do |var|
+    res[var]=ENV[var]
+  end
+
+  res
+end
+
+def docker_up(args, &block)
+	name = args.keys[0]
+
+	deps = args[name]
+
+	compose_params = deps.select { |d| d.is_a? Hash }
+
+	# Get docker-compose file path
+	compose = compose_params.first[:compose]
+
+	# Raise error if :compose value is nil
+	unless compose
+		message = I18n.t('errors.docker_up.no_compose_provided')
+		raise(Panoramix::Plugin::DockerUpExceptionError, message)
+	end
+
+	# Get flags
+	flags = {}
+
+	# Get environment
+	environment = parse_env(compose_params.first[:env] || [])
+
+	# Merge deps with the compose file_task
+	prerequisites = deps.select { |d| ! d.is_a? Hash }
+	prerequisites = prerequisites.push(compose)
+
+	# Set host as a new prerequisite if needed
+	host_dep = Panoramix.resolve_host_dependencies
+	prerequisites = prerequisites.push(host_dep) unless host_dep.nil?
+
+	# Get hostname for this scope
+	host = Panoramix.current_host_name
+
+	instance = Panoramix::Plugin::DockerUp.new(name, compose, environment, host)
+
+	descriptions = I18n.t('docker_up')
+	descriptions = Hash.new if descriptions.class != Hash
+
+	Panoramix.define_tasks(name, descriptions, instance, prerequisites, block)
+end

data/lib/panoramix/plugin/git.rb

@@ -0,0 +1,109 @@
+require "time"
+require "panoramix/plugin/base"
+
+module Panoramix
+	module Plugin
+		class Git < Base
+
+			attr_reader :dst
+			attr_reader :src
+			attr_reader :tag
+
+			def initialize(dst, src, tag, host)
+				super host
+				# Get git project name
+			  repo_name=src.split("/").last.gsub(".git", "")
+
+			  # Base path under which project will be downloaded
+			  base_path=dst.split(repo_name)[0..-1].join(repo_name)
+
+			  @dst=File.join(base_path, repo_name)
+				@src = src
+				@tag = tag
+			end
+
+			# Return current timestamp
+			def timestamp
+				return Time.at 0 unless created?
+		    git_time = shell("git -C #{@dst} log -1 --format=\"%cd\"", true)[:out]
+		    #TODO check exit code
+		    Time.parse(git_time)
+			end
+
+			# When this instance needs to be executed
+			def needed? timestamps
+				return true if !created?
+				# Get remote branches
+				remote = shell("git ls-remote #{src}", true)[:out].split("\n")
+
+				# Is @tag a branch?
+				is_branch = remote.select { |r| r.include?("refs/heads/#{tag}") }
+
+				if is_branch.any?
+					# Compare local refs with remote ref
+					remote_ref = is_branch.first.gsub /\t/, ' '
+					local_refs = shell("git -C #{@dst} show-ref", true)[:out].split("\n")
+
+					return !local_refs.include?(remote_ref)
+				end
+
+				#TODO: To be implemented for tags and commits
+
+				return true
+			end
+
+			# Has this instance already been created
+			def created?
+				File.directory?(@dst)
+			end
+
+			# Action clean fot this task
+			def clean
+				shell "rm -rf #{@dst}"
+			end
+
+			# Default action for this task
+			def run_default
+				if created?
+		      shell "git -C #{@dst} pull"
+		    # File does not exists, so clone the full repository
+		    else
+		      shell "git clone #{@src} #{@dst}"
+		    end
+
+		    # Switch to tag
+		    shell "git -C #{@dst} checkout #{@tag}"
+			end
+
+			def validate
+				out = shell("git ls-remote #{@src} | grep \'#{@tag}$\' | wc -l", true)
+				if (! out[:exit_status].success? || out[:out] =~ /0/)
+					 message = I18n.t('errors.git.not_found', {:branch => @src, :tag => @tag})
+          raise(ValidationError, message) 
+				end
+			end
+
+		end
+	end
+end
+
+def git(args, prerequisites, block=nil)
+	# Name of the task
+	name = args.keys[0]
+	# Get :git value from arguments
+	src = args.values[0][:git]
+	# Get :tag value from arguments
+	tag = args.values[0][:tag]
+
+	# Git tasks always run as local
+	host = "local"
+
+	# Generate a new instance using the provided arguments
+	instance = Panoramix::Plugin::Git.new(name, src, tag, host)
+
+	descriptions = I18n.t('git')
+	descriptions = Hash.new if descriptions.class != Hash
+
+	# Define git instance tasks
+	Panoramix.define_tasks(name, descriptions, instance, prerequisites, block)
+end

data/lib/panoramix/plugin/provision.rb

@@ -0,0 +1,95 @@
+require "panoramix/plugin/base"
+
+module Panoramix
+	module Plugin
+		class Provision < Base
+
+			attr_reader :host
+			attr_accessor :config
+
+			def initialize(host, config)
+				super host
+				@host = host
+				@config = config
+			end
+
+			# Return current timestamp
+			def timestamp
+				if created?
+	        @host.timestamp
+	      else
+	        Time.at 0
+      	end
+			end
+
+			# When this instance needs to be executed
+			def needed? timestamps
+				!created?
+			end
+
+			# Has this instance already been created
+			def created?
+				@host.deployed?
+			end
+
+			# Action clobber for this task
+			def clobber
+				terminate_instance
+			end
+
+			 # Run a new instance
+	    def run_instance args
+	      @host.run_instance args
+	    end
+
+			# Terminate instance
+	    def terminate_instance args=nil
+	      unless args
+	        args=@config
+	      end
+
+	      @host.terminate_instance args
+	    end
+
+			# Default action for this task
+			def run_default
+				raise "Machine already created" if created?
+				run_instance @config
+			end
+
+			# Get aws status
+			def ps
+		    	if created?
+	          		puts "Timestamp: #{timestamp}"
+					puts @host.status
+				else
+					puts "Timestamp: Not created"
+				end
+				puts
+			end
+
+
+		end
+	end
+end
+
+
+def provision(&block)
+
+	raise "Provision defined outside an scope" unless Rake.application.current_scope.any?
+
+	# Get host for this task
+	name = Rake.application.current_scope.first
+
+	# Get host for this task
+	host = Panoramix::Hosts[name][:instance]
+
+	instance = Panoramix::Plugin::Provision.new(host, host.machine.config)
+
+	descriptions = I18n.t('provision')
+	descriptions = Hash.new if descriptions.class != Hash
+
+	prerequisites = []
+
+	Panoramix.define_tasks(:host, descriptions, instance, prerequisites, block)
+end