quest 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f44a8be44d1dabdcf3496a45686269255c4af45c
+  data.tar.gz: e3c77ca330b15ba15d9b20d84f82325c6115f901
+SHA512:
+  metadata.gz: 293f9cd835a9d13c1efc8b162ea15bdbe20a1e9bcb6a914f3a1aecb4934b79cdab8275ef5a3ce4d7bf1920a2f718c9097d6332aee9fa4a6f81f4e200df1d587a
+  data.tar.gz: b353bfcbb12b6ccfc0071f13d2289c21f4aac540e6ddf06baff0d78130c8b6e803cfa7f16d44d6e3dad62385f28c04ed8b187affdf2446587cf0c146e093a234

data/LICENSE

@@ -0,0 +1,15 @@
+   Copyright (C) 2015 Puppet Labs Inc
+
+   Puppet Labs can be contacted at: info@puppetlabs.com
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,99 @@
+## Quest
+
+Quest-driven learning with RSpec and Serverspec.
+
+### What it is
+
+The quest gem provides a learner with live feedback as a learner progresses through
+a series of configuration management tasks defined by RSpec tests.
+It was designed to support the [Puppet Quest Guide](https://github.com/puppetlabs/puppet-quest-guide)
+content on the [Puppet Learning VM](https://puppetlabs.com/download-learning-vm), but can be
+used for any project with a compatible format.
+
+### Installation
+
+From source:
+
+    git clone https://github.com/puppetlabs/quest.git
+    cd quest
+    gem build quest.gemspec
+    gem install quest<VERSION>.gem
+
+### Setup
+
+This gem was designed to support the [Puppet Quest Guide](https://github.com/puppetlabs/puppet-quest-guide),
+and works with any set of tests and metadata following the same pattern.
+
+Any project you wish to use with this tool must contain a directory with the following contents:
+
+An `index.json` file consisting with available quest names, the list of files to watch for each quest
+and an optional setup command for that quest. These setup commands will be run with the directory
+of your tests as the current working directory when a user begins the quest.
+
+```
+{
+  "welcome": {
+    "setup_command": "puppet apply ./manifests/welcome.pp"
+  }
+}
+```
+
+A series of `*_spec.rb` files corresponding the the quest names specified in the `index.json`.
+These files must contain valid Rspec tests that correspond to the tasks in that quest. For example,
+`my_first_quest_spec.rb` might contain the following. (Note the callous abuse of the RSpec format to
+coerce its output into something appropriate to the quest tool interface.)
+
+```
+describe "Task 1: do
+  it 'create a user named test' do
+    file('/etc/passwd').should contain "test"
+  end
+end
+describe "Task 2: do
+ ...
+end
+```
+
+A `spec_helper` file with any required libraries, helper functions, or variables
+needed by the tests.
+
+```
+require 'serverspec'
+require 'pathname'
+
+PROD_PATH = '/etc/puppetlabs/code/environments/production'
+MODULE_PATH = PROD_PATH + "modules/"
+```
+
+### Use
+
+The `questctl` command is used to start the quest service. Run it from the
+task directory, or use the `--task_dir` flag.
+
+```
+/usr/local/bin/questctl start --task_dir /usr/src/puppet-quest-guide/tests
+```
+
+This works best when the service is managed by an init system, for example:
+
+```
+# /etc/systemd/system/quest.service
+[Unit]
+Description=Quest tool service
+
+[Service]
+ExecStart=/usr/local/bin/questctl start --task_dir /usr/src/puppet-quest-guide/tests
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### How it works
+
+The quest service runs a set of RSpec tests for the current test in a loop,
+updating the quest status each time the test completes. The service provides
+api endpoints on port 4567 that allow access to the RSpec output and a POST
+endpoint to change the current quest.
+
+The `quest` command is a wrapper for these API endpoints.
+

data/bin/ballad

@@ -0,0 +1,10 @@
+#!usr/bin/env ruby
+
+begin
+  require 'quest'
+rescue LoadError
+  require 'rubygems'
+  require 'quest'
+end
+
+Rack::Handler::WEBrick.run(Quest::API.new, {:Port => 9393, :Host => '0.0.0.0', :Bind => '0.0.0.0'})

data/bin/quest

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'quest'
+  require 'gli'
+  require 'net/http'
+  require 'json'
+rescue
+  require 'rubygems'
+  require 'quest'
+  require 'gli'
+  require 'json'
+end
+
+module GLIWrapper
+  include GLI::App
+  extend self
+
+  BASE_URI = URI('http://localhost:4567/')
+  OFFER_BAILOUT = false
+
+  def get_path(*path)
+    begin
+      Net::HTTP.get(URI.join(BASE_URI, *path))
+    rescue Errno::ECONNREFUSED => e
+      puts "You may need to restart the quest service: systemctl restart quest"
+      raise e
+    end
+  end
+
+  def post_path(form_data, *path)
+    begin
+      Net::HTTP.post_form(URI.join(BASE_URI, *path), form_data)
+    rescue Errno::ECONNREFUSED => e
+      puts "You may need to restart the quest service: systemctl restart quest"
+      raise e
+    end
+  end
+
+  def offer_bailout(message)
+    print "#{message} Continue? [Y/n]:"
+    raise "Cancelled" unless [ 'y', 'yes', ''].include? STDIN.gets.strip.downcase
+  end
+
+  def fancy_status
+    active_quest = get_path('active_quest')
+    output = "Quest: #{active_quest}\n"
+    examples = JSON.parse(get_path('status/', 'examples'))
+    examples.each do |example|
+      if example["status"] == "passed"
+        output << '√ '.green
+      else
+        output << 'X '.yellow
+      end
+      output << example["full_description"] + "\n"
+    end
+    output
+  end
+
+  def summary_status
+    active_quest = get_path('active_quest')
+    output = "Quest: #{active_quest} - Progress: "
+    summary = JSON.parse(get_path('status/', 'summary'))
+    complete_count = summary["example_count"].to_i - summary["failure_count"].to_i
+    output << "#{complete_count} of #{summary['example_count']} tasks."
+  end
+
+  program_desc 'Track the status of quests and tasks.'
+
+  desc 'Begin a quest'
+  arg :quest_name
+  arg_name 'quest_name'
+  command :begin do |c|
+    c.action do |global_options, options, args|
+      if args.length < 1
+        raise 'You must specify a quest name. Refer to the Quest Guide or use the "quest list" command.'
+      elsif not JSON.parse(get_path('quests')).include? args[0]
+        raise "#{args[0]} is not a valid quest name. Refer to the Quest Guide or use the \"quest list\" command."
+      elsif OFFER_BAILOUT and not get_path('status/', 'summary/', 'failure_count') == '0'
+        offer_bailout("The current quest is not complete. If you begin a new quest, your agent nodes will be reset. Your master node and Puppet code will not be affected.\n")
+      end
+      post_path({}, 'begin/', args[0])
+      puts "You have started the #{args[0]} quest."
+    end
+  end
+
+  desc 'List available quests'
+  command :list do |c|
+    c.action do |global_options, options, args|
+      puts JSON.parse(get_path('quests'))
+    end
+  end
+
+  desc 'Show status of the current quest'
+  command :status do |c|
+    c.switch [:s], :desc => 'Show status in summary form.'
+    c.action do |global_options, options, args|
+      if options[:s]
+        puts summary_status 
+      else
+        puts fancy_status
+      end
+    end
+  end
+
+  exit run(ARGV)
+end

data/bin/questctl

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'quest'
+require 'gli'
+
+module GLIWrapper
+  include GLI::App
+  extend self
+
+  # Controllers for the quest service
+  # Move to questctl
+
+  program_desc 'Controller for quest tool services.'
+
+  desc 'Start the quest service'
+  command :start do |c|
+    c.flag [:q, :task_dir, 'task_dir'], :desc => 'Specify the task directory.'
+    c.action do |global_options, options, args|
+      messenger = Quest::Messenger.new( {'task_dir' => options[:task_dir]} )
+      api = Thread.new do
+        Quest::API.set :messenger, messenger
+        Quest::API.run!
+      end
+      watcher = Thread.new do
+        Quest::QuestWatcher.new(messenger).run!
+      end
+      Signal.trap("INT") do
+        puts "Exiting"
+        Thread.kill watcher
+        Thread.kill api
+        exit 130
+      end
+      watcher.join
+      api.join
+    end
+  end
+  exit run(ARGV)
+end

data/bin/test_all_quests

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'quest'
+require 'net/http'
+
+BASE_URI = URI('http://localhost:4567/')
+
+def get_path(*path)
+  Net::HTTP.get(URI.join(BASE_URI, *path))
+end
+
+def post_path(form_data, *path)
+  Net::HTTP.post_form(URI.join(BASE_URI, *path), form_data)
+end
+
+quests = JSON.parse(get_path('quests'))
+
+quests.each do |q|
+  completion_script = File.join('/usr/src/puppet-quest-guide/tests', 'test_tests', "#{q}.sh")
+  `#{completion_script}`
+end

data/lib/quest.rb

@@ -0,0 +1,6 @@
+require 'quest/logger'
+require 'quest/messenger'
+require 'quest/rspec_runner'
+require 'quest/quest_watcher'
+require 'quest/colorization'
+require 'quest/api'

data/lib/quest/api.rb

@@ -0,0 +1,83 @@
+require 'sinatra/base'
+
+module Quest
+
+  class API < Sinatra::Base
+
+    # Set defaults
+    before { content_type 'application/json' }
+    not_found { JSON.dump("error" => "Not Found") }
+
+    set :traps, false
+
+    helpers do
+      def messenger
+        settings.messenger
+      end
+      def quest_status
+        settings.messenger.quest_status
+      end
+      def active_quest
+        settings.messenger.active_quest
+      end
+      def active_quest_status
+        settings.messenger.quest_status[settings.messenger.active_quest]
+      end
+    end
+
+    get '/status' do
+      active_quest_status.to_json
+    end
+
+    get '/status/examples' do
+      active_quest_status['examples'].to_json
+    end
+
+    get '/status/examples/:number' do
+      active_quest_status['examples'][params[:number].to_i - 1].to_json
+    end
+
+    get '/status/examples/count' do
+      content_type 'text/html'
+      active_quest_status['examples'].size
+    end
+
+    get '/status/examples/:number/description' do
+      active_quest_status['examples'][params[:number].to_i - 1]['description'].to_json
+    end
+
+    get '/status/examples/:number/file_path' do
+      active_quest_status['examples'][params[:number].to_i - 1]['file_path'].to_json
+    end
+
+    get '/status/examples/:number/status' do
+      active_quest_status['examples'][params[:number].to_i - 1]['status'].to_json
+    end
+
+    get '/status/examples/:number/run_time' do
+      active_quest_status['examples'][params[:number].to_i - 1]['run_time'].to_json
+    end
+
+    get '/status/summary' do
+      active_quest_status['summary'].to_json
+    end
+
+    get '/status/summary/failure_count' do
+      active_quest_status['summary']['failure_count'].to_json
+    end
+
+    get '/active_quest' do
+      content_type 'text/html'
+      active_quest
+    end
+
+    get '/quests' do
+      messenger.quests.to_json
+    end
+
+    post '/begin/:quest' do
+      messenger.begin_quest(params[:quest])
+    end
+  end
+
+end

data/lib/quest/colorization.rb

@@ -0,0 +1,26 @@
+class String
+def black;          "\e[30m#{self}\e[0m" end
+def red;            "\e[31m#{self}\e[0m" end
+def green;          "\e[32m#{self}\e[0m" end
+def brown;          "\e[33m#{self}\e[0m" end
+def yellow;         "\e[1;33m#{self}\e[0m" end
+def blue;           "\e[34m#{self}\e[0m" end
+def magenta;        "\e[35m#{self}\e[0m" end
+def cyan;           "\e[36m#{self}\e[0m" end
+def gray;           "\e[37m#{self}\e[0m" end
+
+def bg_black;       "\e[40m#{self}\e[0m" end
+def bg_red;         "\e[41m#{self}\e[0m" end
+def bg_green;       "\e[42m#{self}\e[0m" end
+def bg_brown;       "\e[43m#{self}\e[0m" end
+def bg_blue;        "\e[44m#{self}\e[0m" end
+def bg_magenta;     "\e[45m#{self}\e[0m" end
+def bg_cyan;        "\e[46m#{self}\e[0m" end
+def bg_gray;        "\e[47m#{self}\e[0m" end
+
+def bold;           "\e[1m#{self}\e[21m" end
+def italic;         "\e[3m#{self}\e[23m" end
+def underline;      "\e[4m#{self}\e[24m" end
+def blink;          "\e[5m#{self}\e[25m" end
+def reverse_color;  "\e[7m#{self}\e[27m" end
+end

data/lib/quest/logger.rb

@@ -0,0 +1,5 @@
+require 'mono_logger'
+
+module Quest
+  LOGGER = MonoLogger.new(STDOUT)
+end

data/lib/quest/messenger.rb

@@ -0,0 +1,77 @@
+# -*- encoding : utf-8 -*-
+
+require 'json'
+
+module Quest
+
+  # Shared state and methods for reading from the content directory
+  class Messenger
+
+    require 'fileutils'
+
+    attr_reader   :quest_index_file
+    attr_reader   :spec_helper
+    attr_accessor :active_quest
+    attr_accessor :quest_status
+
+    def initialize(config = {})
+      @task_dir  = config['task_dir']  || Dir.pwd
+      @quest_index_file  = File.join(@task_dir, 'index.json')
+      validate_task_dir
+      @spec_helper       = File.join(@task_dir, 'spec_helper.rb')
+      @quest_status = {}
+      @active_quest = quests.first
+      run_setup_command(@active_quest)
+    end
+
+    def set_raw_status(quest, raw_status_hash)
+      @quest_status[quest] = raw_status_hash
+    end
+
+    def validate_task_dir
+      begin
+        JSON.parse(File.read(@quest_index_file))
+      rescue Errno::ENOENT
+        puts "No valid quest index.json file found at #{@quest_index_file}"
+        exit 1
+      end
+    end
+
+    def run_setup_command(quest)
+      if setup_command
+        begin
+          puts "Setting up the #{active_quest} quest..."
+          Dir.chdir(@task_dir){
+            setup_io = IO.popen(setup_command) do |io|
+              io.each do |line|
+                puts line
+              end
+            end
+          }
+        rescue
+          puts "Setup for #{active_quest} failed"
+        end
+      end
+    end
+
+    def spec_path(quest)
+      File.join(@task_dir, "#{quest}_spec.rb")
+    end
+
+    def quests
+      JSON.parse(File.read(@quest_index_file)).keys
+    end
+
+    def setup_command
+      JSON.parse(File.read(@quest_index_file))[@active_quest]["setup_command"]
+    end
+
+    def begin_quest(quest)
+      if quests.include?(quest)
+        @active_quest = quest
+        run_setup_command(quest)
+      end
+    end
+
+  end
+end

data/lib/quest/quest_watcher.rb

@@ -0,0 +1,31 @@
+require 'timers'
+
+module Quest
+  class QuestWatcher
+
+    def initialize(messenger)
+      @messenger = messenger
+      @timers = Timers::Group.new
+      @lock = Mutex.new
+    end
+
+    def start_timer
+      task_timer = @timers.now_and_every(5) do
+        unless @lock.locked?
+          @lock.lock
+          active_quest = @messenger.active_quest
+          runner = Quest::RSpecRunner.new(@messenger.spec_path(active_quest), @messenger.spec_helper)
+          @messenger.set_raw_status(active_quest, runner.result)
+          @lock.unlock
+        end
+      end
+      loop {@timers.wait}
+    end
+
+    # This is the main function to set up and run the watcher process
+    def run!
+      start_timer
+    end
+
+  end
+end

data/lib/quest/rspec_runner.rb

@@ -0,0 +1,37 @@
+module Quest
+  class RSpecRunner
+    # Based loosely on https://github.com/guard/guard-rspec/blob/master/lib/guard/rspec/rspec_process.rb
+
+    attr_reader :result
+
+    def initialize(spec_file, spec_helper)
+      @spec_file       = spec_file
+      @spec_helper     = spec_helper
+      Tempfile.open('quest-rspec-runner') do |tmp_file|
+        @exit_code = run_spec(@spec_file, @spec_helper, tmp_file.path)
+        @result   = read_result(tmp_file.path)
+      end
+    end
+
+    def run_spec(spec_file, spec_helper, tmp_file)
+      home = ENV["HOME"] || '/tmp'
+      command  = "HOME=#{home} rspec #{spec_file} -r #{spec_helper} -f json -o #{tmp_file}"
+      begin
+        pid = Kernel.spawn(command)
+        result = ::Process.wait2(pid)
+        result.last.exitstatus
+      rescue Errno::ENOENT => ex
+        raise Failure, "Failed: #{command} (#{ex})"
+      end
+    end
+
+    def read_result(tmp_file)
+      begin
+        JSON.parse(File.read(tmp_file))
+      rescue Errno::ENOENT => ex
+        raise Failure, "Cannot open status file #{tmp_file}, (#{ex})"
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: quest
+version: !ruby/object:Gem::Version
+  version: 1.0.7
+platform: ruby
+authors:
+- Kevin Henner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.36'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.36'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: quest uses serverspec to track completion of configuration management
+  related learning tasks.
+email:
+- kevin@puppetlabs.com
+executables:
+- quest
+- questctl
+- test_all_quests
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/ballad
+- bin/quest
+- bin/questctl
+- bin/test_all_quests
+- lib/quest.rb
+- lib/quest/api.rb
+- lib/quest/colorization.rb
+- lib/quest/logger.rb
+- lib/quest/messenger.rb
+- lib/quest/quest_watcher.rb
+- lib/quest/rspec_runner.rb
+homepage: http://github.com/puppetlabs/quest
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Track completion of configuration management tasks.
+test_files: []
+has_rdoc: