vagrant-logs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49e28a7c0aa315d741308b034b1832ce1c7ba03b
+  data.tar.gz: fecad9fe7923088f9be67e978663488727ebb321
+SHA512:
+  metadata.gz: afc575872ae72d3a674b7f425a1b3339f7fd47e780400cb51eedd5bda88a7eacbbb89aaa889036b50644a5efef345183ead851446e836f0ccb4b4b020d017a23
+  data.tar.gz: 00a0d86e4b175d36f01ca4f5b688c097e82b5972e61a6110340ca9bb0c718f66a3e44313ffa7ffc22b645da82158179fee347fd2b77fff7df563b98a06289b2e

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.gem
+*.rbc
+.vagrant
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+
+script:
+  - bundle exec rake test

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+ 1. Fork it
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
+ 4. Push to the branch (`git push origin my-new-feature`)
+ 5. Create new Pull Request
+
+# publishing new release
+
+Use `bundle exec rake release` to tag & publish a new release

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'gist'
+
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+  # gem "vagrant", git: "git://github.com/mitchellh/vagrant.git", tag: "v1.7.4"
+  # gem "vagrant", git: "git://github.com/mitchellh/vagrant.git", tag: "v1.3.5"
+
+  gem 'rubocop', require: false
+end
+
+group :plugins do
+  gem 'vagrant-logs', path: '.'
+  gem 'bib-vagrant'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Till Klampaeckel, Florian Holzhauer, ImagineEasy Solutions LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,79 @@
+# VagrantLogs
+
+[![Build Status](https://travis-ci.org/easybiblabs/vagrant-logs.png?branch=master)](https://travis-ci.org/easybiblabs/vagrant-logs)
+[![Coverage Status](https://coveralls.io/repos/easybiblabs/vagrant-status/badge.png)](https://coveralls.io/r/easybiblabs/vagrant-logs)
+
+This is a work in progress - and subject to [additions and changes](CONTRIBUTING.md).
+
+## Objective
+
+ 1. Print several log information ...
+ 2. ...and / or upload them to a Gist.
+
+## Installation
+
+Install the plugin:
+
+    $ vagrant plugin install vagrant-logs
+
+Do not use this command in a directory with a Vagrantfile which requires the plugin. Vagrant does _always_ include the Vagrantfile, and therefore will fail before installation because of the missing plugin. Just ```cd``` somewhere else and retry the command, maybe from your homedir?
+
+## Usage
+
+### Gist upload
+
+Upload to Gist can be activated by setting environment variable `GIST_UPLOAD`, e.g.:
+
+`GIST_UPLOAD=true vagrant logs`
+
+`GITHUB_TOKEN` must also be set as an environment variable.
+
+### Vagrantfile
+
+In your `Vagrantfile`:
+
+```ruby
+Vagrant.require_plugin 'vagrant-logs'
+
+Vagrant.configure("2") do |config|
+  # list of log files
+  config.vagrant_logs.log_files = ['/var/log/*log']
+
+  # number of lines to log
+  config.vagrant_logs.lines = 5
+
+  # list of locally checked out repositories for which the current revision should be logged
+  config.vagrant_logs.repositories_to_check = ['~/Sites/easybib/cookbooks', '~/projects/ies/vagrant-logs']
+
+  # list of locally available clients to check for their versions
+  config.vagrant_logs.clients_to_check = ['vagrant', 'VBoxManage']
+end
+```
+
+## Developing and Testing
+
+Make sure you are using a Bundler version which is compatible with Vagrant which comes from GitHub like defined here:
+
+```
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+```
+
+Bundler version 1.10.6 works fine and can be installed like this:
+
+```
+gem install bundler -v '~> 1.10.6'
+```
+
+Then, when you want to test Bib Vagrant use:
+
+```
+bundle _1.10.6_ exec vagrant
+```
+
+Happy developing and testing.
+
+## Contributing
+
+See [Contributing](CONTRIBUTING.md)

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/autorun'
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+
+task :test do
+  $LOAD_PATH.unshift('lib', 'test')
+  Dir.glob('./test/*_test.rb') do |f|
+    require f
+  end
+end

data/Vagrantfile

@@ -0,0 +1,10 @@
+Vagrant.configure('2') do |config|
+  # for testing ubuntu 14.04
+  config.vm.box = 'trusty-server-cloudimg-amd64-vagrant-disk1.box'
+  config.vm.box_url = 'https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box'
+
+  config.vagrant_logs.log_files = ['/var/log/*log']
+  config.vagrant_logs.lines = 5
+  # config.vagrant_logs.repositories_to_check = ['~/Sites/easybib/cookbooks']
+  config.vagrant_logs.clients_to_check = ['vagrant', 'VBoxManage']
+end

data/lib/vagrant-logs/command.rb

@@ -0,0 +1,216 @@
+require 'gist'
+
+
+module VagrantPlugins
+  module CommandLogs
+    class Command < Vagrant.plugin('2', :command)
+      def self.synopsis
+        'Print some log and information (and upload them to a Gist)'
+      end
+
+      def execute
+        result = {}
+
+        with_target_vms(@argv, single_target: true) do |vm|
+          prepare_log_file_names(vm)
+          result[:log_files] = fetch_log_files(vm)
+
+          result[:repository_revisions] = fetch_repository_revisions(vm)
+          result[:client_versions] = fetch_client_versions(vm)
+          result[:dns_resolution] = fetch_dns_resolution_check(vm)
+        end
+
+        result_as_string = result_to_string(result)
+
+        print result_as_string
+
+        if ENV['GIST_UPLOAD']
+          upload_to_gist(result_as_string, ENV['GITHUB_TOKEN'])
+        end
+
+        return 0
+      end
+
+
+      protected
+
+      def prepare_log_file_names(vm)
+        vm.config.vagrant_logs.log_files = expand_log_file_names(vm.config.vagrant_logs.log_files, vm)
+      end
+
+      def expand_log_file_names(log_files, vm)
+        puts "Expand files names: "
+
+        expanded_file_names = []
+
+        log_files.delete_if do |log_file|
+          if log_file.include?('*')
+            vm.communicate.sudo("ls -1 #{log_file}") do |type, data|
+              case type
+              when :stdout
+                expanded_file_names << data.split(/[\r\n]+/)
+              when :stderr
+                puts data and exit 1
+              end
+            end
+
+            true
+          end
+        end
+
+        puts "Ok\n"
+
+        (log_files + expanded_file_names).flatten
+      end
+
+      def fetch_log_files(vm)
+        puts "Fetch log files: "
+        result = {}
+
+        vm.config.vagrant_logs.log_files.each do |log_file|
+          vm.communicate.sudo("tail -#{vm.config.vagrant_logs.lines} #{log_file}") do |type, data|
+            case type
+            when :stdout
+              result[log_file] = data.split(/[\r\n]+/)
+            when :stderr
+              puts data and exit 1
+            end
+          end
+        end
+
+        puts "Ok\n"
+
+        result
+      end
+
+      def log_files_result_to_string(log_files_results)
+        result  = "Log files\n"
+        result += "---------\n"
+
+        if log_files_results.nil?
+          result += "None fetched.\n"
+        else
+          log_files_results.each do |filename, log_file_results|
+            result += "#{filename}\n"
+            log_file_results.each do |log_file_result|
+              result += "#{log_file_result}\n"
+            end
+            result += "\n\n\n"
+          end
+        end
+
+        result + "\n"
+      end
+
+      def fetch_client_versions(vm)
+        result = {}
+
+        vm.config.vagrant_logs.clients_to_check.each do |client|
+          result[client] = `#{client} -v`
+        end
+
+        result
+      end
+
+      def client_versions_to_string(client_versions)
+        result =  "Client versions\n"
+        result += "---------------\n"
+
+        if !client_versions.nil? and client_versions.any?
+          client_versions.each do |client, version|
+            result += "#{client}: #{version}\n"
+          end
+        else
+          result += "None checked.\n"
+        end
+
+        result + "\n"
+      end
+
+      def fetch_repository_revisions(vm)
+        result = {}
+
+        vm.config.vagrant_logs.repositories_to_check.each do |repository|
+          result[repository] = `(cd #{repository} && git rev-parse HEAD)`
+        end
+
+        result
+      end
+
+      def repository_revisions_to_string(repository_revisions)
+        result =  "Repository revisions\n"
+        result += "--------------------\n"
+
+        if !repository_revisions.nil? and repository_revisions.any?
+          repository_revisions.each do |repository, revision|
+            result += "#{repository}: #{revision}\n"
+          end
+        else
+          result += "None checked.\n"
+        end
+
+        result + "\n"
+      end
+
+      def fetch_dns_resolution_check(vm)
+        puts "DNS resolution check: "
+
+        result = ''
+
+        vm.communicate.sudo("host -t ns google.com") do |type, data|
+          case type
+          when :stdout
+            result = data
+          when :stderr
+            puts data and exit 1
+          end
+        end
+
+        puts "Ok\n"
+
+        !result.include?('no servers could be reached')
+      end
+
+      def dns_resolution_result_to_string(dns_resolution)
+        result =  "DNS resolution\n"
+        result += "--------------\n"
+
+        if dns_resolution == true
+          result += "Fine, works.\n"
+        elsif dns_resolution == false
+          result += "Doesn't seem to work.\n"
+        else
+          result += "Not checked.\n"
+        end
+
+        result + "\n"
+      end
+
+      def result_to_string(result)
+        repository_revisions_to_string(result[:repository_revisions]) +
+        client_versions_to_string(result[:client_versions]) +
+        dns_resolution_result_to_string(result[:dns_resolution]) +
+        log_files_result_to_string(result[:log_files])
+      end
+
+      def upload_to_gist(result, access_token)
+        puts "Gist upload\n"
+        puts "-----------\n"
+
+        if access_token.nil? or access_token.empty?
+          puts "Access token is missing (ENV['GITHUB_TOKEN']).\n"
+        else
+          gist = Gist.gist(result, filename: Time.now.to_i.to_s, access_token: access_token)
+
+          if gist
+            puts "Url: #{gist['html_url']}\n"
+          else
+            puts "Upload failed.\n"
+          end
+        end
+
+        puts "\n"
+      end
+    end
+  end
+end

data/lib/vagrant-logs/config.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module CommandLogs
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :log_files
+      attr_accessor :lines
+      attr_accessor :repositories_to_check
+      attr_accessor :clients_to_check
+
+
+      def initialize
+        @log_files = UNSET_VALUE
+        @lines = UNSET_VALUE
+        @repositories_to_check = UNSET_VALUE
+        @clients_to_check = UNSET_VALUE
+      end
+
+      def finalize!
+        if @log_files == UNSET_VALUE
+          @log_files = %w(/var/log/syslog /var/log/nginx/*log /var/log/php/*log .vagrant.d/data/landrush/log)
+        end
+
+        @lines = 50 if @lines == UNSET_VALUE
+
+        config = Bib::Vagrant::Config.new
+        @repositories_to_check = [config.get['cookbook_path']] || [] if @repositories_to_check == UNSET_VALUE
+
+        @clients_to_check = ['vagrant', 'VBoxManage'] if @clients_to_check == UNSET_VALUE
+      end
+    end
+  end
+end

data/lib/vagrant-logs/plugin.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module CommandLogs
+    class Plugin < Vagrant.plugin('2')
+      name 'vagrant-logs'
+
+      description 'Plugin allows printing logs or save them to a Gist'
+
+      command 'logs' do
+        require_relative 'command'
+        Command
+      end
+
+      config 'vagrant_logs' do
+        require_relative 'config'
+        Config
+      end
+    end
+  end
+end

data/lib/vagrant-logs/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module CommandLogs
+    VERSION = '0.0.1'
+  end
+end

data/lib/vagrant-logs.rb

@@ -0,0 +1,4 @@
+require 'vagrant-logs/command'
+require 'vagrant-logs/config'
+require 'vagrant-logs/plugin'
+require 'vagrant-logs/version'

data/vagrant-logs.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'vagrant-logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-logs'
+  spec.version       = VagrantPlugins::CommandLogs::VERSION
+  spec.platform		   = Gem::Platform::RUBY
+  spec.authors       = %w('seppsepp', 'fh')
+  spec.email         = ['sebastian.lenk@gmail.com']
+  spec.description   = 'A RubyGem to print log files and/or upload them to a Gist'
+  spec.summary       = 'Print log files and/or upload to Gist'
+  spec.homepage      = 'https://github.com/easybiblabs/vagrant-logs'
+  spec.license       = 'New BSD License'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gist'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0.8'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-logs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- "'seppsepp',"
+- "'fh'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gist
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: A RubyGem to print log files and/or upload them to a Gist
+email:
+- sebastian.lenk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-logs.rb
+- lib/vagrant-logs/command.rb
+- lib/vagrant-logs/config.rb
+- lib/vagrant-logs/plugin.rb
+- lib/vagrant-logs/version.rb
+- vagrant-logs.gemspec
+homepage: https://github.com/easybiblabs/vagrant-logs
+licenses:
+- New BSD License
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Print log files and/or upload to Gist
+test_files: []