charmkit 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05364a4374be704b432ec856dbc035ce451e85c1
-  data.tar.gz: de1fcd348a2deba7363ca267cfc4142bc66cc88a
+  metadata.gz: 2f742ba89357ad616835697ea86d6f9a079f3faf
+  data.tar.gz: 2432ac3a5dce8a156d1ff2c4112c7a04a2d5279c
 SHA512:
-  metadata.gz: '008297d5686d1508a1f333e35717d2507dd09fc65a8e7e6497a8956e9af7da7cc1fd86a9b1dc9974fe1af5cb35de090957ae00693328521f5f774f18919092ee'
-  data.tar.gz: 58327894324fcd05a17310addf9ba61686582c31565baf8442ee47cc10c4135d3721aae2afd16379659ee86bcc122091c6737e0f09d9c0b544c927cd49db8477
+  metadata.gz: 0a7ddce6c4a359fb5da2c00755857013cc5d2a10ae30faf9918f563ced7b9f8d38c2e367d03f1440c5ecc43081aae0684cf712e3097207c77ecf4f00b49a86e6
+  data.tar.gz: 690573d393d1ed24982e2401d6eae53e69b26e27acf81b4292659a6efac64b921ff30793c1f44a871196c37778d0299805a1f81f4392ab0a200c03db8d482859

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/cache

data/README.md

@@ -22,48 +22,107 @@ Or install it yourself as:
 In **hooks/install**:
 
 ```
-#!/bin/bash
+#!/bin/sh
 
 apt-get update
 apt-get install -qyf ruby
 gem install bundler
 
-bundle install --standalone
+bundle install --local --quiet
+
+# Runs the lib/install.rb hook
+bundle exec charmkit install
+```
+
+In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed**)
+
+```
+#!/bin/sh
+
+bundle exec charmkit config-changed
+```
+
+Same for **hooks/upgrade-charm**
+
+```
+#!/bin/sh
+
+bundle exec charmkit upgrade-charm
 ```
 
-In other hooks (eg. **hooks/config-changed**)
+## Writing Charmkit style hooks
+
+All Charmkit hooks must reside in the charm's toplevel **lib/** directory. Those
+files must match the name of the hook you want to assicate to and must end with
+a **.rb** extension.
+
+For example, if my hook runs `bundle exec charmkit config-changed` then in my
+**lib/** directory should exist a file named **lib/config-changed.rb**.
+
+To start, you'll want to inherit from the **Charmkit** class. The class name should also
+reflect the name of the hook being executed and should be in a standard Ruby camelcase style.
+
+See the syntax below for a the **config-changed** hook being run:
+
+### Syntax
 
 ```ruby
-#!/usr/bin/env ruby
-require_relative '../bundle/bundler/setup'
 require 'charmkit'
 
-package [
-    'nginx-full', 'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
-    'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
-  ], :update_cache
+class ConfigChanged < Charmkit
+  plugin :core
+  plugin :hookenv
+
+  def summon
+    package [
+        'nginx-full', 'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
+        'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
+    ], :update_cache
+
+    hook_path = ENV['JUJU_CHARM_DIR']
+    app_path = config 'app_path'
 
-hook_path = ENV['JUJU_CHARM_DIR']
-app_path = config 'app_path'
+    mkdir app_path unless is_dir? app_path
 
-mkdir app_path unless is_dir? app_path
+    release = config 'release'
 
-release = config 'release'
+    case release
+    when "stable"
+      resource_path = resource 'stable-release'
+    when "development"
+      resource_path = resource 'development-release'
+    else
+      status :blocked, "Unknown release given #{release}"
+      exit 1
+    end
 
-case release
-when "stable"
-  resource_path = resource 'stable-release'
-when "development"
-  resource_path = resource 'development-release'
-else
-  status :blocked, "Unknown release given #{release}"
-  exit 1
+    run "tar xf #{resource_path} -C #{app_path} --strip-components=1"
+
+    rm "#{app_path}/conf/install.php" unless !is_file? "#{app_path}/conf/install.php"
+  end
 end
+```
+
+The core of Charmkit is relatively small and everything is handled through
+plugins. Current plugins are:
 
-run "tar xf #{resource_path} -C #{app_path} --strip-components=1"
+* core - Gives you access to things like *package*, *mkdir_p*, *chown_R*, etc.
+* hookenv - Provides access to Juju hook items such as *resource*, *unit*, *juju-log*, etc.
+
+## Packaging the Charm
+
+You'll want to make sure that any Ruby gems used are packaged with your charm so
+that you aren't forcing users to try to download those dependencies during
+deployment.
+
+Easiest way to package your deps is:
 
-rm "#{app_path}/conf/install.php" unless !is_file? "#{app_path}/conf/install.php"
 ```
+$ bundle package
+```
+
+This will place your deps inside `vendor/cache` which will be uploaded when
+executing a `charm push .`
 
 ## Development
 
@@ -88,4 +147,3 @@ the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 The gem is available as open source under the terms of
 the [MIT License](http://opensource.org/licenses/MIT).
-

data/charmkit.gemspec

@@ -5,7 +5,7 @@ require 'charmkit/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "charmkit"
-  spec.version       = Charmkit::VERSION
+  spec.version       = Charmkit.version
   spec.authors       = ["Adam Stokes"]
   spec.email         = ["battlemidget@users.noreply.github.com"]
 
@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
 end

data/examples/CKfile

@@ -0,0 +1,137 @@
+# -*- mode:ruby -*-
+
+name "dokuwiki"
+summary "Dokuwiki is a simple to use wiki"
+desc <<~EOF
+DokuWiki is a simple to use and highly versatile Open Source wiki software
+that doesn't require a database. It is loved by users for its clean and
+readable syntax.
+EOF
+maintainer 'Adam Stokes <adam.stokes@ubuntu.com>'
+license 'MIT'
+copyright_holder 'Canonical Ltd.'
+copyright_year '2016'
+url "https://github.com/battlemidget/juju-charm-dokuwiki.rb"
+bugs "https://github.com/battlemidget/juju-charm-dokuwiki.rb/issues"
+
+series "xenial"
+series "trusty"
+
+# CONFIG ######################################################################
+# These items will be exposed to the charm via `config-get`
+config "app_path" do
+  type :string
+  default "/srv/app"
+  desc "Where to store dokuwiki source"
+end
+
+config "release" do
+  type :string
+  default "/srv/app"
+  desc "Dokuwiki release"
+end
+
+config "admin_user" do
+  type :string
+  default "admin"
+  desc "Admin username (default: admin)"
+end
+
+config "admin_password" do
+  type :string
+  default "5f4dcc3b5aa765d61d8327deb882cf99"
+  desc "Admin password md5 hash format (default password: password)"
+end
+
+config "admin_name" do
+  type :string
+  default "The Admin"
+  desc "Name of admin"
+end
+
+config "admin_email" do
+  type :string
+  default "adam@root.me"
+  desc "Admin email"
+end
+# END #########################################################################
+
+# RESOURCES ###################################################################
+# These items will be exposed to the charm via `resource-get`
+resource "stable-release" do
+  type :file
+  filename "stable.tgz"
+  desc "Dokuwiki stable"
+end
+
+resource "development-release" do
+  type :file
+  filename "deveopment.tgz"
+  desc "Dokuwiki development"
+end
+# END #########################################################################
+
+depends_on "nginx-full"
+depends_on "php-fpm"
+depends_on "php-cgi"
+depends_on "php-curl"
+depends_on "php-gd"
+depends_on "php-json"
+depends_on "php-mcrypt"
+depends_on "php-readline"
+depends_on "php-mbstring"
+depends_on "php-xml"
+
+hook "install" do
+  release = "#{config['release']}-release"
+  app_path = config 'app_path'
+  hook_path = ENV['JUJU_CHARM_DIR']
+  run "tar xf #{resource[release]} -C #{app_path} --strip-components=1"
+  rm "#{app_path}/conf/install.php" if is_file? "#{app_path}/conf/install.php"
+  cp "#{hook_path}/templates/acl.auth.php", "#{app_path}/conf/acl.auth.php"
+  cp "#{hook_path}/templates/local.php", "#{app_path}/conf/local.php"
+  cp "#{hook_path}/templates/plugins.local.php", "#{app_path}/conf/plugin.local.php"
+  file "/etc/dokuwiki-release", content: release
+  case release
+  when "stable"
+    version = cat "#{app_path}/VERSION"
+    run "application-version-set '#{version}'"
+  when "development"
+    t = Time.now
+    version = t.strftime "%Y-%m-%d"
+    run "application-version-set 'development-#{version}'"
+  else
+    status :blocked, "Unable to set proper application version"
+    exit 1
+  end
+end
+
+hook "config-changed" do
+  app_path = config 'app_path'
+  hook_path = ENV['JUJU_CHARM_DIR']
+  installed_release = cat "/etc/dokuwiki-release"
+  release = config 'release'
+  if !installed_release.eql? release
+    run './hooks/install'
+  end
+
+  admin_user = config 'admin_user'
+  admin_password = config 'admin_password'
+  admin_name = config 'admin_name'
+  admin_email = config 'admin_email'
+  template "#{hook_path}/templates/users.auth.php",
+           "#{app_path}/conf/users.auth.php",
+           admin_user: admin_user,
+           admin_password: admin_password,
+           admin_name: admin_name,
+           admin_email: admin_email
+
+  template "#{hook_path}/templates/vhost.conf",
+           "/etc/nginx/sites-enabled/default",
+           public_address: unit['public-address'],
+           app_path: app_path
+
+  chown_R 'www-data', 'www-data', app_path
+  run "systemctl restart nginx"
+  status :active, "Ready"
+end

data/examples/basic.rb

@@ -1,6 +1,6 @@
-require 'charmkit'
+require_relative './plugin_loader'
 
-run 'ls -l /tmp'
-status :active, "running application status..."
-package ['znc', 'znc-perl', 'znc-python'], :update_cache
-is_installed? 'znc'
+# run 'ls -l /tmp'
+# status :active, "running application status..."
+# package ['znc', 'znc-perl', 'znc-python'], :update_cache
+# is_installed? 'znc'

data/examples/plugin_loader.rb

@@ -0,0 +1,9 @@
+require 'charmkit'
+
+class Install < Charmkit
+  plugin :core
+
+  def summon
+    puts run 'ls -l /tmp'
+  end
+end

data/exe/charmkit

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "charmkit/extend/string_tools"
+
+if ARGV.length > 1
+  puts "To many arguments, should be one of 'install, config-changed, start, stop, upgrade-charm'"
+  exit 1
+end
+
+hook_name = ARGV.pop
+
+if File.exists?("./lib/#{hook_name}.rb")
+  require "./lib/#{hook_name}"
+else
+  puts "Could not find hook in ./lib/#{hook_name}.rb"
+  exit 1
+end
+
+puts "Loading #{hook_name}"
+m = Object.const_get(hook_name.classify).new
+m.summon

data/lib/charmkit/extend/string_tools.rb

@@ -0,0 +1,14 @@
+class String
+  # Simple classify to rename our hooks to their proper class
+  #
+  # charmkit config-changed
+  #
+  # This will load config-changed.rb and classify it's name to
+  # ConfigChanged.
+  #
+  # Note most libraries use '_'(underscore) for word separation whereas
+  # Juju hooks are '-'(hyphenated).
+  def classify
+    return self.split('-').collect!{ |w| w.capitalize }.join
+  end
+end

data/lib/charmkit/plugins/core.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+require 'tty-command'
+require 'erb'
+
+class Charmkit
+  module Plugins
+    module Core
+      module InstanceMethods
+        FileUtils.singleton_methods.each do |m|
+          define_method m, FileUtils.method(m).to_proc
+        end
+
+        def file(dst, content:)
+          File.write(dst, content)
+        end
+
+        def is_file?(path)
+          return File.exists? path
+        end
+
+        def is_dir?(path)
+          return Dir.exists? path
+        end
+
+        def cat(src)
+          return File.read(src)
+        end
+
+        # Run commands optionally getting it's output, error
+        #
+        # run 'ls -l /tmp'
+        def run(data)
+          if ENV['DRYRUN']
+            puts "DRYRUN: #{data}"
+          else
+            cmd = TTY::Command.new(printer: :null)
+            return cmd.run(data)
+          end
+        end
+
+
+        # Processes templates
+        #
+        # template 'my-template.erb' '/etc/config/me.conf', service_name: "nginx"
+        class TemplateRenderer
+          def self.empty_binding
+            binding
+          end
+
+          def self.render(template_content, locals = {})
+            b = empty_binding
+            locals.each { |k, v| b.local_variable_set(k, v) }
+            ERB.new(template_content).result(b)
+          end
+        end
+
+        def template(src, dst, **context)
+          rendered = TemplateRenderer.render(File.read(src), context)
+          File.write(dst, rendered)
+        end
+
+
+        # Installs packages
+        #
+        # package ['nginx-full'], :update_cache
+        def package(packages, *opts)
+          if opts.include?(:update_cache)
+            run "apt-get update"
+          end
+          run "apt-get install -qyf #{packages.join(' ')}"
+        end
+
+        def is_installed?(package)
+          begin
+            run "dpkg -s #{package}" and return true
+          rescue
+            return false
+          end
+        end
+      end
+    end
+    register_plugin(:core, Core)
+  end
+end

data/lib/charmkit/plugins/hookenv.rb

@@ -0,0 +1,44 @@
+class Charmkit
+  module Plugins
+    module HookEnv
+      module ClassMethods
+        # calls status-set in juju environment
+        def status(level=:maintenance, msg="")
+          levels = [:maintenance, :active, :blocked, :waiting]
+          raise unless levels.include?(level)
+          run "status-set #{level.to_s} '#{msg}'"
+        end
+
+        def config(item)
+          out, err = run "config-get '#{item}'"
+          return out.chomp
+        end
+
+        def resource(item)
+          out, err = run "resource-get '#{item}'"
+          return out.chomp
+        end
+
+        def unit(item)
+          out, err = run "unit-get '#{item}'"
+          return out.chomp
+        end
+
+        def action(item)
+          out, err = run "action-get '#{item}'"
+          return out.chomp
+        end
+
+        def action=(item)
+          out, err = run "action-set '#{item}'"
+          return out.chomp
+        end
+
+        def log(msg)
+          run "juju-log #{msg}"
+        end
+      end
+    end
+    register_plugin(:hookenv, HookEnv)
+  end
+end

data/lib/charmkit/version.rb

@@ -1,3 +1,14 @@
-module Charmkit
-  VERSION = "0.3.4"
+class Charmkit
+  def self.version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 3
+    PATCH = 5
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
 end

data/lib/charmkit.rb

@@ -1,9 +1,71 @@
-require "charmkit/runner"
-require "charmkit/hook-tools"
-require "charmkit/package"
-require "charmkit/template"
-require "charmkit/fs"
 require "charmkit/version"
 
-module Charmkit end
-extend Charmkit::DSL
+class Charmkit
+  # A generic exception by Charmkit
+  class Error < StandardError; end
+
+  @opts = {}
+
+  module Plugins
+    @plugins = {}
+
+    def self.load_plugin(name)
+      unless plugin = @plugins[name]
+        require "charmkit/plugins/#{name}"
+        raise Error, "plugin #{name} did not register itself correctly in Charmkit::Plugins" unless plugin = @plugins[name]
+      end
+      plugin
+    end
+
+    def self.register_plugin(name, mod)
+      @plugins[name] = mod
+    end
+
+    module Base
+      module ClassMethods
+        # Generic options for this class, plugins store their options here.
+        attr_reader :opts
+
+        def inherited(subclass)
+          subclass.instance_variable_set(:@opts, opts.dup)
+          subclass.opts.each do |key, value|
+            if value.is_a?(Enumerable) && !value.frozen?
+              subclass.opts[key] = value.dup
+            end
+          end
+        end
+        def plugin(plugin, *args, &block)
+          plugin = Plugins.load_plugin(plugin) if plugin.is_a?(Symbol)
+          plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
+          self.include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
+          self.extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)
+          plugin.configure(self, *args, &block) if plugin.respond_to?(:configure)
+          nil
+        end
+
+      end
+      module InstanceMethods
+        # The class-level options hash. This should probably not be modified at
+        # the instance level.
+        def opts
+          self.class.opts
+        end
+
+        # This performs the actual work of installing, configuring, restarting
+        # of services.
+        #
+        #    class Install < Charmkit
+        #      def summon
+        #        cp "#{ENV['JUJU_CHARM_DIR']}/templates/nginx.conf.tpl",
+        #           "/etc/nginx/nginx.conf"
+        #      end
+        #    end
+        def summon
+        end
+      end
+    end
+  end
+
+  extend Plugins::Base::ClassMethods
+  plugin Plugins::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: charmkit
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Adam Stokes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-command
@@ -66,10 +66,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: ''
 email:
 - battlemidget@users.noreply.github.com
-executables: []
+executables:
+- charmkit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -84,15 +99,16 @@ files:
 - bin/console
 - bin/setup
 - charmkit.gemspec
+- examples/CKfile
 - examples/basic.rb
+- examples/plugin_loader.rb
 - examples/template.rb
 - examples/templates/user_auth.txt
+- exe/charmkit
 - lib/charmkit.rb
-- lib/charmkit/fs.rb
-- lib/charmkit/hook-tools.rb
-- lib/charmkit/package.rb
-- lib/charmkit/runner.rb
-- lib/charmkit/template.rb
+- lib/charmkit/extend/string_tools.rb
+- lib/charmkit/plugins/core.rb
+- lib/charmkit/plugins/hookenv.rb
 - lib/charmkit/version.rb
 homepage: http://charmkit.org
 licenses:

data/lib/charmkit/fs.rb

@@ -1,21 +0,0 @@
-require 'fileutils'
-
-module Charmkit
-  module DSL
-    FileUtils.singleton_methods.each do |m|
-      define_method m, FileUtils.method(m).to_proc
-    end
-    def is_file?(path)
-      return File.exists? path
-    end
-    def is_dir?(path)
-      return Dir.exists? path
-    end
-    def spew(dst, content)
-      File.write(dst, content)
-    end
-    def slurp(src)
-      return File.read(src)
-    end
-  end
-end

data/lib/charmkit/hook-tools.rb

@@ -1,40 +0,0 @@
-# Hook tools module for exposing things such as status-set and action-set
-module Charmkit
-  module DSL
-    # calls status-set in juju environment
-    def status(level=:maintenance, msg="")
-      levels = [:maintenance, :active, :blocked, :waiting]
-      raise unless levels.include?(level)
-      run "status-set #{level.to_s} '#{msg}'"
-    end
-
-    def config(item)
-      out, err = run "config-get #{item}"
-      return out.chomp
-    end
-
-    def resource(item)
-      out, err = run "resource-get #{item}"
-      return out.chomp
-    end
-
-    def unit(item)
-      out, err = run "unit-get #{item}"
-      return out.chomp
-    end
-
-    def action(item)
-      out, err = run "action-get #{item}"
-      return out.chomp
-    end
-
-    def action=(item)
-      out, err = run "action-set #{item}"
-      return out.chomp
-    end
-
-    def log(msg)
-      run "juju-log #{msg}"
-    end
-  end
-end

data/lib/charmkit/package.rb

@@ -1,19 +0,0 @@
-module Charmkit
-  module DSL
-    # installs apt packages
-    def package(packages, *opts)
-      if opts.include?(:update_cache)
-        run "apt-get update"
-      end
-      run "apt-get install -qyf #{packages.join(' ')}"
-    end
-
-    def is_installed?(package)
-      begin
-        run "dpkg -s #{package}" and return true
-      rescue
-        return false
-      end
-    end
-  end
-end

data/lib/charmkit/runner.rb

@@ -1,14 +0,0 @@
-require "tty-command"
-
-module Charmkit
-  module DSL
-    def run(data)
-      if ENV['DRYRUN']
-        puts "DRYRUN: #{data}"
-      else
-        cmd = TTY::Command.new(printer: :null)
-        return cmd.run(data)
-      end
-    end
-  end
-end

data/lib/charmkit/template.rb

@@ -1,22 +0,0 @@
-require 'erb'
-
-module Charmkit
-  module DSL
-    class TemplateRenderer
-      def self.empty_binding
-        binding
-      end
-
-      def self.render(template_content, locals = {})
-        b = empty_binding
-        locals.each { |k, v| b.local_variable_set(k, v) }
-        ERB.new(template_content).result(b)
-      end
-    end
-
-    def template(src, dst, **context)
-      rendered = TemplateRenderer.render(File.read(src), context)
-      File.write(dst, rendered)
-    end
-  end
-end