charmkit 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cab89bb4367d2520c771adeccc76c45e4098adfc
-  data.tar.gz: 351e253c40b3dd3b8470bb54315e5acc76a61d67
+  metadata.gz: 34c131cea62bf4d8cf2e3fd63e5919962c62fa37
+  data.tar.gz: c0252140b1e1f42646961889f077950e6f1989c3
 SHA512:
-  metadata.gz: 0aee6d94779fd83872a7d733a14b70b7bde72cc815e2a077a224d95aa6f6e5fe2968d0c72a68b956263044c2553803528d3ff360ae99ff8846a6565ab55a9433
-  data.tar.gz: 5889275117a7f500349ae48e1c17758015419ab2ad3b4e305b33078327b8a07e4202993d286f61963e6eb489dfecb9241a2205d172d07fbd8ca5ac7196c3c0c4
+  metadata.gz: df357ff4b8222ae01e4e5d724dbd4d5e813216ee378b4e3d3e37de6a2ed958adfaf03eb51fcbc2dcf3ee5558f709351ee02cd90b70a53c2934ddc5a390aec6da
+  data.tar.gz: 12e5bc325ced514f7a5858d3685ef4b43bed7082715497cfe0db8828d02ef582aadd782201c0cb3f9feaaa572f4f1db9f88cf2604a58b1cf4a1893399d3e4a80

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/README.md

@@ -19,29 +19,27 @@ 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 bundler --no-install-recommends
+apt-get install -qyf ruby --no-install-recommends
+gem install bundler
 
-bundle install --local --quiet --without development
+bundle install --local --quiet
 
-bundle exec rake dokuwiki:install
+# Runs the lib/install.rb hook
+bundle exec charmkit hook install
 ```
 
-In other hooks call the relevant rake tasks, for example, in
-**hooks/config-changed**:
+In other hooks call *charmkit* with the execing hook (eg. **hooks/config-changed**)
 
 ```
 #!/bin/sh
 
-bundle exec rake dokuwiki:config_changed
+bundle exec charmkit hook config-changed
 ```
 
 Same for **hooks/upgrade-charm**
@@ -49,126 +47,80 @@ Same for **hooks/upgrade-charm**
 ```
 #!/bin/sh
 
-bundle exec rake dokuwiki:install
+bundle exec charmkit hook upgrade-charm
 ```
 
 ## Writing Charmkit style hooks
 
-All Charmkit hooks will reside in a normal **Rakefile**.
+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 hook 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
-require 'charmkit'
-require 'charmkit/plugins/nginx'
-require 'charmkit/plugins/php'
+class ConfigChanged < Charmkit::Hook
+  use :nginx
 
-namespace :dokuwiki do
+  summon do
+    package [
+        'php-fpm',      'php-cgi',      'php-curl', 'php-gd', 'php-json',
+        'php-mcrypt', 'php-readline', 'php-mbstring', 'php-xml'
+    ], :update_cache
 
-  desc "Install Dokuwiki"
-  task :install => ["nginx:install", "php:install"] do
-    app_path = `config-get app_path`
-    resource_path = `resource-get stable-release`
     hook_path = ENV['JUJU_CHARM_DIR']
+    app_path = path(config('app_path'))
 
-    mkdir_p app_path unless Dir.exists? app_path
+    mkdir app_path
 
-    `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"
+    resource_path = path(resource('stable-release'))
+    run "tar xf #{resource_path} -C #{app_path} --strip-components=1"
 
-    version = File.read "#{app_path}/VERSION"
-    `application-version-set '#{version}'`
-    `status-set active Dokuwiki Install finished.`
+    rm app_path/"conf/install.php"
+    status :active, "Dokuwiki configuration updated."
   end
 
-  desc "Configure Dokuwiki"
-  task :config_changed do
-    app_path = `config-get app_path`
-    hook_path = ENV['JUJU_CHARM_DIR']
-
-    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`
+  test do
+    cmd.test '-e /etc/passwd'
   end
 end
 ```
 
-The core of Charmkit contains a few helpers such as template rendering but
-otherwise kept relatively small.
-
-**Charmkit** does have a sense of "plugins" which are really **rake** tasks that
-reside in *charmkit/plugin/{name}* as seen in the example syntax above.
+The core of Charmkit is relatively small and everything is handled through
+scrolls (read
+plugins). [Visit Charmkit Scrolls](https://github.com/charmkit/charmkit-scrolls)
+for more information.
 
-## Using local plugins
 
-In addition to the plugins(read: rake tasks) you can add your own to the charm
-itself. To add a task either create a directory inside your charm (eg.
-**tasks**) and name the file something relvant. For example, to create a plugin
-that will install **vim** you would do the following inside your charm directory:
-
-Create a file **tasks/vim.rb** with the below syntax:
+## Packaging the Charm
 
-```ruby
-namespace :vim do
-  desc "install vim"
-  task :install do
-   system("apt-get install -qyf vim")
-  end
-end
 ```
-
-And in your **Rakefile** include it in using the **require_relative** syntax:
-
-```ruby
-require 'charmkit'
-require_relative 'tasks/vim'
+$ bundle exec charmkit build
 ```
 
-Now you can install **vim** with the rake command or utilize the tasks inside
-your **Rakefile**:
+This will package and cache all required gems, along with making sure the necessary
+scrolls are included. The output will be a charm that you can deploy via:
 
 ```
-bundle exec rake vim:install
+$ juju deploy dist/.
 ```
 
-## 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.
+## Uploading to charm store
 
-Easiest way to package your deps is:
+Once the charm is built simply run:
 
 ```
-$ bundle package
+$ charm push dist/.
 ```
 
-This will place your deps inside `vendor/cache` which will be uploaded when
-executing a `charm push .`
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/charmkit.gemspec

@@ -1,11 +1,10 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'charmkit/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "charmkit"
-  spec.version       = Charmkit.version
+  spec.version       = "1.0.0"
   spec.authors       = ["Adam Stokes"]
   spec.email         = ["battlemidget@users.noreply.github.com"]
 
@@ -21,9 +20,10 @@ 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"
+  spec.add_dependency "tty-command", "~> 0.2.0"
   spec.add_dependency "activesupport"
   spec.add_dependency "thor"
+  spec.add_dependency "rake"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/examples/Charmkitfile

@@ -0,0 +1,66 @@
+# -*- mode:ruby -*-
+
+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

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

data/examples/demo/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "charmkit", :github => "charmkit/charmkit"
+gem "rake"
+gem "rspec"
+
+# If you wish to load additional scrolls add those here
+gem "charmkit-scroll-nginx", :github => "charmkit/charmkit-scrolls-nginx"
+

data/examples/demo/Gemfile.lock

@@ -0,0 +1,64 @@
+GIT
+  remote: git://github.com/charmkit/charmkit-scrolls-nginx.git
+  revision: d0a7493d4832de2588a136afb8b312569b8a1158
+  specs:
+    charmkit-scroll-nginx (0.2.0)
+
+GIT
+  remote: git://github.com/charmkit/charmkit.git
+  revision: 9dc6a1acb34c8c0bf63977e68b5c60ab74242b87
+  specs:
+    charmkit (1.0.2)
+      activesupport
+      thor
+      tty-command (~> 0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.4)
+    diff-lcs (1.3)
+    equatable (0.5.0)
+    i18n (0.7.0)
+    minitest (5.10.1)
+    pastel (0.6.1)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.3.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tty-color (0.3.0)
+    tty-command (0.2.0)
+      pastel (~> 0.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  charmkit!
+  charmkit-scroll-nginx!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.13.7

data/examples/demo/README.md

@@ -0,0 +1,27 @@
+# Overview
+
+My charm Overview
+
+# Usage
+
+    $ juju deploy demo
+
+# Developers
+
+How developers can contribute
+
+# Maintainers
+
+How QA and others can test your charm
+
+# Author
+
+Your name <mememe@email.com>
+
+# Copyright
+
+2016 Your name
+
+# License
+
+MIT

data/examples/demo/Rakefile

@@ -0,0 +1,9 @@
+require 'charmkit'
+
+desc "Install hook"
+task :install do
+  use :nginx
+  nginx.add_host "test", :php
+  deps.install
+end
+

data/examples/demo/config.yaml

@@ -0,0 +1,2 @@
+options: {}
+

data/examples/demo/hooks/config-changed

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake config_changed
+

data/examples/{my-demo-charm → demo}/hooks/install

@@ -1,8 +1,6 @@
 #!/bin/sh
-
 apt-get update && apt-get install -qyf ruby bundler --no-install-recommends
-
-bundle install --local --quiet
-
+bundle install --local --quiet --without development
 # Do install task
-bundle exec rake dokuwiki:install
+bundle exec rake install
+