manifests-cf-plugin 0.7.0.rc1

data/Rakefile

@@ -0,0 +1,5 @@
+require "rake"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/manifests-cf-plugin.rb

@@ -0,0 +1,317 @@
+require "yaml"
+require "set"
+
+require "manifests-cf-plugin/loader"
+
+
+module CFManifests
+  MANIFEST_FILE = "manifest.yml"
+
+  @@showed_manifest_usage = false
+
+  def manifest
+    return @manifest if @manifest
+
+    if manifest_file && File.exists?(manifest_file)
+      @manifest = load_manifest(manifest_file)
+    end
+  end
+
+  def save_manifest(save_to = manifest_file)
+    fail "No manifest to save!" unless @manifest
+
+    File.open(save_to, "w") do |io|
+      YAML.dump(@manifest, io)
+    end
+  end
+
+  # find the manifest file to work with
+  def manifest_file
+    return @manifest_file if @manifest_file
+
+    unless path = input[:manifest]
+      where = Dir.pwd
+      while true
+        if File.exists?(File.join(where, MANIFEST_FILE))
+          path = File.join(where, MANIFEST_FILE)
+          break
+        elsif File.basename(where) == "/"
+          path = nil
+          break
+        else
+          where = File.expand_path("../", where)
+        end
+      end
+    end
+
+    return unless path
+
+    @manifest_file = File.expand_path(path)
+  end
+
+  # load and resolve a given manifest file
+  def load_manifest(file)
+    Loader.new(file, self).manifest
+  end
+
+  # dynamic symbol resolution
+  def resolve_symbol(sym)
+    case sym
+    when "target-url"
+      client_target
+
+    when "target-base"
+      target_base
+
+    when "random-word"
+      sprintf("%04x", rand(0x0100000))
+
+    when /^ask (.+)/
+      ask($1)
+    end
+  end
+
+  # find apps by an identifier, which may be either a tag, a name, or a path
+  def find_apps(identifier)
+    return [] unless manifest
+
+    apps = apps_by(:name, identifier)
+
+    if apps.empty?
+      apps = apps_by(:path, from_manifest(identifier))
+    end
+
+    apps
+  end
+
+  # return all the apps described by the manifest
+  def all_apps
+    manifest[:applications]
+  end
+
+  def current_apps
+    manifest[:applications].select do |app|
+      next unless app[:path]
+      from_manifest(app[:path]) == Dir.pwd
+    end
+  end
+
+  # splits the user's input, resolving paths with the manifest,
+  # into internal/external apps
+  #
+  # internal apps are returned as their data in the manifest
+  #
+  # external apps are the strings that the user gave, to be
+  # passed along wholesale to the wrapped command
+  def apps_in_manifest(input = nil, use_name = true, &blk)
+    names_or_paths =
+      if input.has?(:apps)
+        # names may be given but be [], which will still cause
+        # interaction, so use #direct instead of #[] here
+        input.direct(:apps)
+      elsif input.has?(:app)
+        [input.direct(:app)]
+      elsif input.has?(:name)
+        [input.direct(:name)]
+      else
+        []
+      end
+
+    internal = []
+    external = []
+
+    names_or_paths.each do |x|
+      if x.is_a?(String)
+        if x =~ %r([/\\])
+          apps = find_apps(File.expand_path(x))
+
+          if apps.empty?
+            fail("Path #{b(x)} is not present in manifest #{b(relative_manifest_file)}.")
+          end
+        else
+          apps = find_apps(x)
+        end
+
+        if !apps.empty?
+          internal += apps
+        else
+          external << x
+        end
+      else
+        external << x
+      end
+    end
+
+    [internal, external]
+  end
+
+  def create_manifest_for(app, path)
+    meta = {
+      "name" => app.name,
+      "framework" => app.framework.name,
+      "runtime" => app.runtime.name,
+      "memory" => human_size(app.memory * 1024 * 1024, 0),
+      "instances" => app.total_instances,
+      "url" => app.url ? app.url.sub(target_base, '${target-base}') : "none",
+      "path" => path
+    }
+
+    services = app.services
+
+    unless services.empty?
+      meta["services"] = {}
+
+      services.each do |i|
+        if v2?
+          p = i.service_plan
+          s = p.service
+
+          meta["services"][i.name] = {
+            "label" => s.label,
+            "provider" => s.provider,
+            "version" => s.version,
+            "plan" => p.name
+          }
+        else
+          meta["services"][i.name] = {
+            "vendor" => i.vendor,
+            "version" => i.version,
+            "tier" => i.tier
+          }
+        end
+      end
+    end
+
+    if cmd = app.command
+      meta["command"] = cmd
+    end
+
+    if buildpack = app.buildpack
+      meta["buildpack"] = buildpack
+    end
+
+    meta
+  end
+
+  private
+
+  def relative_manifest_file
+    Pathname.new(manifest_file).relative_path_from(Pathname.pwd)
+  end
+
+  def show_manifest_usage
+    return if @@showed_manifest_usage
+
+    path = relative_manifest_file
+    line "Using manifest file #{c(path, :name)}"
+    line
+
+    @@showed_manifest_usage = true
+  end
+
+  def no_apps
+    fail "No applications or manifest to operate on."
+  end
+
+  def warn_reset_changes
+    line c("Not applying manifest changes without --reset", :warning)
+    line "See `cf diff` for more details."
+    line
+  end
+
+  def apps_by(attr, val)
+    manifest[:applications].select do |info|
+      info[attr] == val
+    end
+  end
+
+  # expand a path relative to the manifest file's directory
+  def from_manifest(path)
+    File.expand_path(path, File.dirname(manifest_file))
+  end
+
+
+  def ask_to_save(input, app)
+    return if manifest_file
+    return unless ask("Save configuration?", :default => false)
+
+    manifest = create_manifest_for(app, input[:path])
+
+    with_progress("Saving to #{c("manifest.yml", :name)}") do
+      File.open("manifest.yml", "w") do |io|
+        YAML.dump(
+          { "applications" => [manifest] },
+          io)
+      end
+    end
+  end
+
+  def env_hash(val)
+    if val.is_a?(Hash)
+      val
+    else
+      hash = {}
+
+      val.each do |pair|
+        name, val = pair.split("=", 2)
+        hash[name] = val
+      end
+
+      hash
+    end
+  end
+
+  def setup_env(app, info)
+    return unless info[:env]
+    app.env = env_hash(info[:env])
+  end
+
+  def setup_services(app, info)
+    return if !info[:services] || info[:services].empty?
+
+    offerings = client.services
+
+    to_bind = []
+
+    info[:services].each do |name, svc|
+      name = name.to_s
+
+      if instance = client.service_instance_by_name(name)
+        to_bind << instance
+      else
+        offering = offerings.find { |o|
+          o.label == (svc[:label] || svc[:type] || svc[:vendor]) &&
+            (!svc[:version] || o.version == svc[:version]) &&
+            (o.provider == (svc[:provider] || "core"))
+        }
+
+        fail "Unknown service offering: #{svc.inspect}." unless offering
+
+        if v2?
+          plan = offering.service_plans.find { |p|
+            p.name == (svc[:plan] || "D100")
+          }
+
+          fail "Unknown service plan: #{svc[:plan]}." unless plan
+        end
+
+        invoke :create_service,
+          :name => name,
+          :offering => offering,
+          :plan => plan,
+          :app => app
+      end
+    end
+
+    to_bind.each do |s|
+      next if app.binds?(s)
+
+      # TODO: splat
+      invoke :bind_service, :app => app, :service => s
+    end
+  end
+
+  def target_base
+    client_target.sub(/^[^\.]+\./, "")
+  end
+end

data/lib/manifests-cf-plugin/errors.rb

@@ -0,0 +1,33 @@
+module CFManifests
+  class InvalidManifest < RuntimeError
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def to_s
+      "Manifest file '#{@file}' is malformed."
+    end
+  end
+
+  class CircularDependency < RuntimeError
+    def initialize(app)
+      @app = app
+    end
+
+    def to_s
+      "Circular dependency in application '#@app'"
+    end
+  end
+
+  class UnknownSymbol < RuntimeError
+    def initialize(sym)
+      @sym = sym
+    end
+
+    def to_s
+      "Undefined symbol in manifest: '#@sym'"
+    end
+  end
+end

data/lib/manifests-cf-plugin/loader.rb

@@ -0,0 +1,31 @@
+require "manifests-cf-plugin/loader/builder"
+require "manifests-cf-plugin/loader/normalizer"
+require "manifests-cf-plugin/loader/resolver"
+
+module CFManifests
+  class Loader
+    include Builder
+    include Normalizer
+    include Resolver
+
+    def initialize(file, resolver)
+      @file = file
+      @resolver = resolver
+    end
+
+    def manifest
+      info = build(@file)
+      normalize! info
+      resolve info, @resolver
+    end
+
+    private
+
+    # expand a path relative to the manifest file's directory
+    def from_manifest(path)
+      return path unless @file
+
+      File.expand_path(path, File.dirname(@file))
+    end
+  end
+end

data/lib/manifests-cf-plugin/loader/builder.rb

@@ -0,0 +1,37 @@
+module CFManifests
+  module Builder
+    # parse a manifest and merge with its inherited manifests
+    def build(file)
+      manifest = YAML.load_file file
+      raise InvalidManifest.new(file) unless manifest
+
+      Array(manifest["inherit"]).each do |path|
+        manifest = merge_parent(path, manifest)
+      end
+
+      manifest.delete("inherit")
+
+      manifest
+    end
+
+    private
+
+    # merge the manifest at `parent_path' into the `child'
+    def merge_parent(parent_path, child)
+      merge_manifest(build(from_manifest(parent_path)), child)
+    end
+
+    # deep hash merge
+    def merge_manifest(parent, child)
+      merge = proc do |_, old, new|
+        if new.is_a?(Hash) && old.is_a?(Hash)
+          old.merge(new, &merge)
+        else
+          new
+        end
+      end
+
+      parent.merge(child, &merge)
+    end
+  end
+end

data/lib/manifests-cf-plugin/loader/normalizer.rb

@@ -0,0 +1,149 @@
+module CFManifests
+  module Normalizer
+    MANIFEST_META = ["applications", "properties"]
+
+    def normalize!(manifest)
+      toplevel = toplevel_attributes(manifest)
+
+      apps = manifest["applications"]
+      apps ||= [{}]
+
+      default_paths_to_keys!(apps)
+
+      apps = convert_to_array(apps)
+
+      merge_toplevel!(toplevel, manifest, apps)
+      normalize_apps!(apps)
+
+      manifest["applications"] = apps
+
+      normalize_paths!(apps)
+
+      keyval = normalize_key_val(manifest)
+      manifest.clear.merge!(keyval)
+
+      nil
+    end
+
+    private
+
+    def normalize_paths!(apps)
+      apps.each do |app|
+        app["path"] = from_manifest(app["path"])
+      end
+    end
+
+    def convert_to_array(apps)
+      return apps if apps.is_a?(Array)
+
+      ordered_by_deps(apps)
+    end
+
+    # sort applications in dependency order
+    # e.g. if A depends on B, B will be listed before A
+    def ordered_by_deps(apps, processed = Set[])
+      ordered = []
+      apps.each do |tag, info|
+        next if processed.include?(tag)
+
+        if deps = Array(info["depends-on"])
+          dep_apps = {}
+          deps.each do |dep|
+            dep_apps[dep] = apps[dep]
+          end
+
+          processed.add(tag)
+
+          ordered += ordered_by_deps(dep_apps, processed)
+          ordered << info
+        else
+          ordered << info
+          processed.add(tag)
+        end
+      end
+
+      ordered.each { |app| app.delete("depends-on") }
+
+      ordered
+    end
+
+    def default_paths_to_keys!(apps)
+      return if apps.is_a?(Array)
+
+      apps.each do |tag, app|
+        app["path"] ||= tag
+      end
+    end
+
+    def normalize_apps!(apps)
+      apps.each do |app|
+        normalize_app!(app)
+      end
+    end
+
+    def merge_toplevel!(toplevel, manifest, apps)
+      return if toplevel.empty?
+
+      apps.collect! do |a|
+        toplevel.merge(a)
+      end
+
+      toplevel.each do |k, _|
+        manifest.delete k
+      end
+    end
+
+    def normalize_app!(app)
+      if app["framework"].is_a?(Hash)
+        app["framework"] = app["framework"]["name"]
+      end
+
+      if app.key?("mem")
+        app["memory"] = app.delete("mem")
+      end
+
+      if app.key?("url") && app["url"].nil?
+        app["url"] = "none"
+      end
+
+      if app.key?("subdomain")
+        if app.key?("host")
+          app.delete("subdomain")
+        else
+          app["host"] = app.delete("subdomain")
+        end
+      end
+    end
+
+    def toplevel_attributes(manifest)
+      top =
+        manifest.reject { |k, _|
+          MANIFEST_META.include? k
+        }
+
+      # implicit toplevel path of .
+      top["path"] ||= "."
+
+      top
+    end
+
+    def normalize_key_val(val)
+      case val
+      when Hash
+        stringified = {}
+
+        val.each do |k, v|
+          stringified[k.to_sym] = normalize_key_val(v)
+        end
+
+        stringified
+      when Array
+        val.collect { |x| normalize_key_val(x) }
+      when nil
+        nil
+      else
+        val.to_s
+      end
+    end
+  end
+end