charmkit 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ade5fcd9040118f5e59723c07c7b97be5b0e026f
-  data.tar.gz: c71e7aab78d9205e14b11c736a1f43cb389ae5c1
+  metadata.gz: 24756041722bd6f0869ceaa2bf01c29b7d580af1
+  data.tar.gz: 07dc358b6837a4686090776d750c95595a8e15ac
 SHA512:
-  metadata.gz: e313cf279ac792d03412d9a4059a8d3d185020a3732ae9ea1e2ff205ef52c592fb71c44c89577af45d18f5fbcc965d3e6652dc92bbf49e0f0c53c47573aed174
-  data.tar.gz: fd1622e6f39d1d83364579dc31d11f965457202f732fe65dcf2df57b96d5fea8a2d98885c3ab1d1ed5382116625d17f8fe258b4369bfc3a8bda917d2d2695a19
+  metadata.gz: 8c4dc17926306904a09e18d34efb3ed1ee913544e6b6b0a77e00519e227e31d2b93c30197ddbd0f3e8313e1055443ec9cd15cc300a22de8e0509a51dcfe20b3a
+  data.tar.gz: 1b376bb8a1fae54c63847b054a819ddbf2e3754b98998d61493ffa6b8b2b3923059a88d90a219839c883bd170eefa11a789981d6adb78822dcbe4f531f418d5c

data/README.md

@@ -19,19 +19,22 @@ Or install it yourself as:
 
 ## Usage
 
+Define all install, configure, upgrade tasks within a normal **Rakefile**. The
+hooks will then need to just call those tasks:
+
 In **hooks/install**:
 
 ```
 #!/bin/sh
 
 apt-get update
-apt-get install -qyf ruby
+apt-get install -qyf ruby --no-install-recommends
 gem install bundler
 
 bundle install --local --quiet
 
 # Runs the lib/install.rb hook
-bundle exec charmkit install
+bundle exec rake dokuwiki:install
 ```
 
 In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed**)
@@ -39,7 +42,7 @@ In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed
 ```
 #!/bin/sh
 
-bundle exec charmkit config-changed
+bundle exec rake dokuwiki:config_changed
 ```
 
 Same for **hooks/upgrade-charm**
@@ -47,67 +50,85 @@ Same for **hooks/upgrade-charm**
 ```
 #!/bin/sh
 
-bundle exec charmkit upgrade-charm
+bundle exec rake dokuwiki:install
+bundle exec rake dokuwiki: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:
+All Charmkit hooks will reside in a normal **Rakefile**.
 
 ### Syntax
 
 ```ruby
 require 'charmkit'
 
-class ConfigChanged < Charmkit
-  plugin :core
-  plugin :hookenv
+namespace :dokuwiki do
 
-  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
+  desc "Install required apt packages"
+  task :install_deps do
+    pkgs = [
+      'nginx-full', 'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
+      'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
+    ]
+    `apt-get update`
+    `apt-get install -qyf #{pkgs.join(' ')}`
+  end
 
+  desc "Install Dokuwiki"
+  task :install => [:install_deps] do
+    app_path = `config-get app_path`
+    resource_path = `resource-get stable-release`
     hook_path = ENV['JUJU_CHARM_DIR']
-    app_path = config 'app_path'
 
-    mkdir app_path unless is_dir? app_path
+    mkdir_p app_path unless Dir.exists? app_path
 
-    release = config 'release'
+    `tar xf #{resource_path} -C #{app_path} --strip-components=1`
+    rm "#{app_path}/conf/install.php" if File.exists? "#{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"
 
-    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
+    version = File.read "#{app_path}/VERSION"
+    `application-version-set '#{version}'`
+    `status-set active Dokuwiki Install finished.`
+  end
 
-    run "tar xf #{resource_path} -C #{app_path} --strip-components=1"
+  desc "Configure Dokuwiki"
+  task :config_changed do
+    app_path = `config-get app_path`
+    hook_path = ENV['JUJU_CHARM_DIR']
 
-    rm "#{app_path}/conf/install.php" unless !is_file? "#{app_path}/conf/install.php"
+    admin_user = `config-get #{admin_user}`
+    admin_password = `config-get admin_password`
+    admin_name = `config-get admin_name`
+    admin_email = `config-get 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
+
+    # TODO: service :restart, "nginx"
+    # TODO: service :restart, "php7.0-fpm"
+    `systemctl restart php7.0-fpm`
+    `systemctl restart nginx`
+    `status-set active Ready`
   end
 end
 ```
 
-The core of Charmkit is relatively small and everything is handled through
-plugins. Current plugins are:
-
-* 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.
+The core of Charmkit contains a few helpers such as template rendering but
+otherwise kept relatively small.
 
 ## Packaging the Charm
 

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+YARD::Rake::YardocTask.new

data/charmkit.gemspec

@@ -21,10 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "tty-command", "~> 0.2.0"
-
   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"
+  spec.add_development_dependency "yard"
 end

data/examples/{CKfile → Charmkitfile}

@@ -1,76 +1,5 @@
 # -*- 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"

data/examples/demo/lib/install.rb

@@ -0,0 +1,30 @@
+require 'charmkit'
+
+class Install < Charmkit
+  plugin :core
+  plugin :nginx
+  plugin :php
+
+  incant :nginx_install do |nginx|
+    ngnix.install
+    nginx.set_vhost server_name: config('server_name'),
+                    application_path: config('app_path')
+  end
+  incant :php_install do |php|
+    php.install version: 7,
+                plugins: ['fpm',
+                          'cgi',
+                          'curl',
+                          'gd',
+                          'json',
+                          'mcrypt',
+                          'readline',
+                          'mbstring',
+                          'xml']
+  end
+
+
+  def summon
+    log "Running example charm code"
+  end
+end

data/examples/demo/readme

@@ -0,0 +1 @@
+example charm demo using charmkit

data/examples/plugin_loader.rb

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

data/examples/template.rb

@@ -1,6 +1,4 @@
 require 'charmkit'
 
-template 'templates/user_auth.txt', '/tmp/user_auth.txt',
+template 'examples/templates/user_auth.txt', '/tmp/user_auth.txt',
          firstname: "joe", lastname: "bob"
-
-file "/tmp/another-test.txt", content: "owned"

data/lib/charmkit/helpers/template.rb

@@ -0,0 +1,25 @@
+require 'erb'
+
+module Charmkit
+  module Helpers
+    # 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
+  end
+end

data/lib/charmkit/plugins/nginx.rb

@@ -0,0 +1,23 @@
+class Charmkit
+  module Plugins
+    module NGINXPlugin
+      module InstanceMethods
+        class NGINX
+          include Charmkit::Helpers::FS
+          def initialize
+            if !is_installed? 'nginx-full'
+              status :maintenance, 'Installing NGINX'
+              package ['nginx-full']
+              status :active, "NGINX installed."
+            end
+            yield(self)
+          end
+          def install_vhost
+            puts "installing vhost"
+          end
+        end
+      end
+    end
+    register_plugin(:nginx, NGINXPlugin)
+  end
+end

data/lib/charmkit/version.rb

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

data/lib/charmkit.rb

@@ -1,71 +1,8 @@
 require "charmkit/version"
+require "charmkit/helpers/template"
 
-class Charmkit
+module 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
+extend Charmkit::Helpers

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: charmkit
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.8
 platform: ruby
 authors:
 - Adam Stokes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: tty-command
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,11 +66,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - battlemidget@users.noreply.github.com
-executables:
-- charmkit
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -99,16 +98,17 @@ files:
 - bin/console
 - bin/setup
 - charmkit.gemspec
-- examples/CKfile
+- examples/Charmkitfile
 - examples/basic.rb
+- examples/demo/lib/install.rb
+- examples/demo/readme
 - examples/plugin_loader.rb
 - examples/template.rb
 - examples/templates/user_auth.txt
-- exe/charmkit
 - lib/charmkit.rb
 - lib/charmkit/extend/string_tools.rb
-- lib/charmkit/plugins/core.rb
-- lib/charmkit/plugins/hookenv.rb
+- lib/charmkit/helpers/template.rb
+- lib/charmkit/plugins/nginx.rb
 - lib/charmkit/version.rb
 homepage: http://charmkit.org
 licenses:

data/exe/charmkit

@@ -1,21 +0,0 @@
-#!/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/plugins/core.rb

@@ -1,84 +0,0 @@
-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

@@ -1,44 +0,0 @@
-class Charmkit
-  module Plugins
-    module HookEnv
-      module InstanceMethods
-        # 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