puppet-debugger 0.4.0

data/lib/version.rb

@@ -0,0 +1,3 @@
+module PuppetDebugger
+  VERSION = '0.4.0'
+end

data/puppet-debugger.gemspec

@@ -0,0 +1,36 @@
+
+require './lib/version'
+
+Gem::Specification.new do |s|
+  s.name = "puppet-debugger"
+  s.version = PuppetDebugger::VERSION
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|resources|local_test_results|pec)/}) }
+  s.bindir        = "bin"
+  s.executables = ["pdb"]
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if s.respond_to?(:metadata)
+    s.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Corey Osman"]
+  s.date = "2016-07-03"
+  s.description = "A interactive command line tool for evaluating the puppet language"
+  s.email = "corey@nwops.io"
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.homepage = "http://github.com/nwops/puppet-debugger"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "A repl for the puppet language"
+  s.add_runtime_dependency(%q<puppet>, [">= 3.8"])
+  s.add_runtime_dependency(%q<facterdb>, ["~> 0.3"])
+  s.add_runtime_dependency(%q<awesome_print>, ["~> 1.6"])
+  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+end

data/run_container_test.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+export PATH=$PATH:/usr/local/bundle
+gem install bundler > /dev/null
+gem update --system > /dev/null
+bundle install --no-color --without development
+bundle exec puppet module install puppetlabs-stdlib
+echo "Running tests, output to ${OUT_DIR}/results.txt"
+bundle exec rspec --out "${OUT_DIR}/results.txt" --format documentation
+# due to concurrency issues we can't build this in parallel
+#gem build puppet-debugger.gemspec
+
+# docker run -e RUBY_VERSION='ruby:1.9.3' -e PUPPET_GEM_VERSION='~> 3.8' --rm -ti -v ${PWD}:/module --workdir /module ruby:1.9.3 /bin/bash run_container_test.sh

data/spec/facts_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe 'facts' do
+  let(:debugger) do
+    PuppetDebugger::Cli.new(:out_buffer => output)
+  end
+
+  let(:puppet_version) do
+    '4.5.3'
+  end
+
+  let(:facter_version) do
+    debugger.default_facter_version
+  end
+
+  before(:each) do
+    allow(Puppet).to receive(:version).and_return(puppet_version)
+  end
+
+  describe '2.4' do
+    before(:each) do
+      ENV['REPL_FACTERDB_FILTER'] = nil
+    end
+    let(:puppet_version) do
+      '4.2.0'
+    end
+    it 'returns 2.4' do
+      expect(facter_version).to eq('/^2\.4/')
+    end
+    it 'return default filter' do
+      expect(debugger.dynamic_facterdb_filter).to eq("operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^2\\.4/")
+    end
+    it 'get node_facts' do
+      expect(debugger.node_facts).to be_instance_of(Hash)
+    end
+    it 'has fqdn' do
+      expect(debugger.node_facts[:fqdn]).to eq('foo.example.com')
+    end
+  end
+
+  describe '3.1' do
+    before(:each) do
+      ENV['REPL_FACTERDB_FILTER'] = nil
+    end
+    let(:puppet_version) do
+      '4.5.3'
+    end
+    it 'get node_facts' do
+      expect(debugger.node_facts).to be_instance_of(Hash)
+    end
+    it 'has networking fqdn' do
+      expect(debugger.node_facts[:networking]['fqdn']).to eq('foo.example.com')
+    end
+    it 'has fqdn' do
+      expect(debugger.node_facts[:fqdn]).to eq('foo.example.com')
+    end
+    it 'returns 3.1' do
+      expect(facter_version).to eq('/^3\.1/')
+    end
+    it 'return default filter' do
+      expect(debugger.dynamic_facterdb_filter).to eq("operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^3\\.1/")
+    end
+  end
+
+  describe 'default facts' do
+    describe 'bad filter' do
+      before(:each) do
+        ENV['REPL_FACTERDB_FILTER'] = 'facterversion=/^6\.5/'
+      end
+      it 'return filter' do
+        expect(debugger.dynamic_facterdb_filter).to eq("facterversion=/^6\\.5/")
+      end
+      it 'throws error' do
+        expect{debugger.default_facts}.to raise_error(PuppetDebugger::Exception::BadFilter)
+      end
+    end
+    describe 'good filter' do
+      before(:each) do
+        ENV['REPL_FACTERDB_FILTER'] = 'facterversion=/^3\.1/'
+      end
+      it 'return filter' do
+        expect(debugger.dynamic_facterdb_filter).to eq("facterversion=/^3\\.1/")
+      end
+    end
+  end
+end

data/spec/fixtures/environments/production/manifests/site.pp

@@ -0,0 +1 @@
+fail('test_error')

data/spec/fixtures/invalid_node_obj.yaml

@@ -0,0 +1,8 @@
+--- !ruby/object:Puppet::Node
+  name: invalid
+  classes: []
+  parameters: []
+  facts:
+  time: 2016-05-10 16:28:21.502653 -07:00
+  environment_name: production
+  expiration: 2016-05-10 16:58:21.502660 -07:00

data/spec/fixtures/node_obj.yaml

@@ -0,0 +1,298 @@
+--- !ruby/object:Puppet::Node
+  name: puppetdev.localdomain
+  classes:
+    stdlib: 
+  parameters:
+    kernel: Linux
+    ipaddress6_lo: "::1"
+    network6_lo: "::1"
+    custom_auth_conf: false
+    puppet_files_dir_present: false
+    selinux: false
+    clientnoop: false
+    is_pe: false
+    hardwareisa: x86_64
+    hardwaremodel: x86_64
+    architecture: x86_64
+    platform_tag: el-7-x86_64
+    rubysitedir: /opt/puppetlabs/puppet/lib/ruby/site_ruby/2.1.0
+    productname: "VMware Virtual Platform"
+    blockdevice_sr0_vendor: NECVMWar
+    facterversion: "3.1.6"
+    processorcount: 1
+    physicalprocessorcount: 1
+    netmask6_eth0: "ffff:ffff:ffff:ffff::"
+    netmask6: "ffff:ffff:ffff:ffff::"
+    pe_concat_basedir: /opt/puppetlabs/puppet/cache/pe_concat
+    chassisassettag: "No Asset Tag"
+    pe_razor_server_version: "package pe-razor-server is not installed"
+    rubyversion: "2.1.8"
+    boardmanufacturer: "Intel Corporation"
+    timezone: UTC
+    bios_vendor: "Phoenix Technologies LTD"
+    os:
+      architecture: x86_64
+      family: RedHat
+      hardware: x86_64
+      name: CentOS
+      release:
+        full: "7.2.1511"
+        major: "7"
+        minor: "2"
+      selinux:
+        enabled: false
+    osfamily: RedHat
+    operatingsystem: CentOS
+    operatingsystemrelease: "7.2.1511"
+    operatingsystemmajrelease: "7"
+    augeasversion: "1.4.0"
+    ipaddress_lo: "127.0.0.1"
+    swapsize_mb: 1108.51953125
+    swapfree_mb: 1108.51953125
+    manufacturer: "VMware, Inc."
+    domain: localdomain
+    bios_version: "6.00"
+    network_lo: "127.0.0.0"
+    gid: root
+    id: root
+    aio_agent_version: "1.4.2"
+    aio_agent_build: "1.4.2"
+    ipaddress6_eth0: "fe80::42:acff:fe11:2"
+    ipaddress6: "fe80::42:acff:fe11:2"
+    netmask_lo: "255.0.0.0"
+    network6: "fe80::"
+    network6_eth0: "fe80::"
+    processor0: "Intel(R) Core(TM) i7-4850HQ CPU @ 2.30GHz"
+    staging_http_get: curl
+    blockdevice_fd0_size: 0
+    uptime_days: 0
+    uptime_hours: 0
+    platform_symlink_writable: true
+    is_virtual: true
+    boardserialnumber: None
+    bios_release_date: "05/20/2014"
+    swapfree: "1.08 GiB"
+    swapsize: "1.08 GiB"
+    uptime: "0:34 hours"
+    mtu_eth0: 1500
+    identity:
+      gid: 0
+      group: root
+      uid: 0
+      user: root
+    puppetversion: "4.4.2"
+    clientversion: "4.4.2"
+    rubyplatform: x86_64-linux
+    chassistype: Other
+    ipaddress_eth0: "172.17.0.2"
+    ipaddress: "172.17.0.2"
+    mtu_lo: 65536
+    macaddress: "02:42:ac:11:00:02"
+    macaddress_eth0: "02:42:ac:11:00:02"
+    augeas:
+      version: "1.4.0"
+    netmask6_lo: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
+    ruby:
+      platform: x86_64-linux
+      sitedir: /opt/puppetlabs/puppet/lib/ruby/site_ruby/2.1.0
+      version: "2.1.8"
+    blockdevice_sda_model: "VMware Virtual S"
+    blockdevice_sda_vendor: "VMware,"
+    processors:
+      count: 1
+      isa: x86_64
+      models:
+        - "Intel(R) Core(TM) i7-4850HQ CPU @ 2.30GHz"
+      physicalcount: 1
+    blockdevices: "fd0,sda,sr0"
+    boardproductname: "440BX Desktop Reference Platform"
+    networking:
+      mac: "02:42:ac:11:00:02"
+      ip6: "fe80::42:acff:fe11:2"
+      hostname: puppetdev
+      netmask6: "ffff:ffff:ffff:ffff::"
+      interfaces:
+        eth0:
+          mac: "02:42:ac:11:00:02"
+          ip6: "fe80::42:acff:fe11:2"
+          bindings:
+            - address: "172.17.0.2"
+              netmask: "255.255.0.0"
+              network: "172.17.0.0"
+          netmask6: "ffff:ffff:ffff:ffff::"
+          netmask: "255.255.0.0"
+          network: "172.17.0.0"
+          mtu: 1500
+          ip: "172.17.0.2"
+          bindings6:
+            - address: "fe80::42:acff:fe11:2"
+              netmask: "ffff:ffff:ffff:ffff::"
+              network: "fe80::"
+          network6: "fe80::"
+        lo:
+          ip6: "::1"
+          bindings:
+            - address: "127.0.0.1"
+              netmask: "255.0.0.0"
+              network: "127.0.0.0"
+          netmask6: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
+          netmask: "255.0.0.0"
+          network: "127.0.0.0"
+          mtu: 65536
+          ip: "127.0.0.1"
+          bindings6:
+            - address: "::1"
+              netmask: "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
+              network: "::1"
+          network6: "::1"
+      fqdn: puppetdev.localdomain
+      netmask: "255.255.0.0"
+      network: "172.17.0.0"
+      mtu: 1500
+      primary: eth0
+      ip: "172.17.0.2"
+      domain: localdomain
+      network6: "fe80::"
+    memoryfree: "788.06 MiB"
+    system_uptime:
+      days: 0
+      hours: 0
+      seconds: 2069
+      uptime: "0:34 hours"
+    uptime_seconds: 2069
+    memoryfree_mb: 788.0625
+    memory:
+      swap:
+        available: "1.08 GiB"
+        available_bytes: 1162366976
+        capacity: "0%"
+        total: "1.08 GiB"
+        total_bytes: 1162366976
+        used: "0 bytes"
+        used_bytes: 0
+      system:
+        available: "788.06 MiB"
+        available_bytes: 826343424
+        capacity: "20.89%"
+        total: "996.13 MiB"
+        total_bytes: 1044512768
+        used: "208.06 MiB"
+        used_bytes: 218169344
+    kernelrelease: "4.1.13-boot2docker"
+    memorysize_mb: 996.125
+    memorysize: "996.13 MiB"
+    hostname: puppetdev
+    virtual: docker
+    interfaces: "eth0,lo"
+    blockdevice_sr0_model: "VMware SATA CD01"
+    netmask: "255.255.0.0"
+    netmask_eth0: "255.255.0.0"
+    trusted:
+      authenticated: remote
+      certname: puppetdev.localdomain
+      domain: localdomain
+      extensions: {}
+      hostname: puppetdev
+    clientcert: puppetdev.localdomain
+    fqdn: puppetdev.localdomain
+    path: "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/root/bin"
+    blockdevice_sr0_size: 31457280
+    kernelversion: "4.1.13"
+    uuid: "564D25BB-6B40-EBBF-38B3-07CCD4455918"
+    network_eth0: "172.17.0.0"
+    network: "172.17.0.0"
+    blockdevice_sda_size: 20971520000
+    kernelmajversion: "4.1"
+    filesystems: "cramfs,ext2,ext3,ext4,iso9660,squashfs,vfat"
+    mountpoints:
+      /etc/hostname:
+        filesystem: ext4
+        device: /dev/sda1
+        used_bytes: 5667684352
+        available_bytes: 13854396416
+        used: "5.28 GiB"
+        size: "18.18 GiB"
+        options:
+          - rw
+          - relatime
+          - "data=ordered"
+        size_bytes: 19522080768
+        available: "12.90 GiB"
+        capacity: "29.03%"
+      /etc/hosts:
+        filesystem: ext4
+        device: /dev/sda1
+        used_bytes: 5667684352
+        available_bytes: 13854396416
+        used: "5.28 GiB"
+        size: "18.18 GiB"
+        options:
+          - rw
+          - relatime
+          - "data=ordered"
+        size_bytes: 19522080768
+        available: "12.90 GiB"
+        capacity: "29.03%"
+      /etc/resolv.conf:
+        filesystem: ext4
+        device: /dev/sda1
+        used_bytes: 5667684352
+        available_bytes: 13854396416
+        used: "5.28 GiB"
+        size: "18.18 GiB"
+        options:
+          - rw
+          - relatime
+          - "data=ordered"
+        size_bytes: 19522080768
+        available: "12.90 GiB"
+        capacity: "29.03%"
+    partitions:
+      /dev/sda1:
+        mount: /etc/resolv.conf
+        size: "18.60 GiB"
+        size_bytes: 19970129920
+      /dev/sda2:
+        size: "954.98 MiB"
+        size_bytes: 1001373696
+    load_averages:
+      "15m": 0.06
+      "1m": 0.06
+      "5m": 0.05
+    disks:
+      fd0:
+        size: "0 bytes"
+        size_bytes: 0
+      sda:
+        model: "VMware Virtual S"
+        size: "19.53 GiB"
+        size_bytes: 20971520000
+        vendor: "VMware,"
+      sr0:
+        model: "VMware SATA CD01"
+        size: "30.00 MiB"
+        size_bytes: 31457280
+        vendor: NECVMWar
+    dmi:
+      bios:
+        release_date: "05/20/2014"
+        vendor: "Phoenix Technologies LTD"
+        version: "6.00"
+      board:
+        manufacturer: "Intel Corporation"
+        product: "440BX Desktop Reference Platform"
+        serial_number: None
+      chassis:
+        asset_tag: "No Asset Tag"
+        type: Other
+      manufacturer: "VMware, Inc."
+      product:
+        name: "VMware Virtual Platform"
+        serial_number: "VMware-56 4d 25 bb 6b 40 eb bf-38 b3 07 cc d4 45 59 18"
+        uuid: "564D25BB-6B40-EBBF-38B3-07CCD4455918"
+    serialnumber: "VMware-56 4d 25 bb 6b 40 eb bf-38 b3 07 cc d4 45 59 18"
+    environment: production
+  facts:
+  time: 2016-05-10 13:14:57.080352 -07:00
+  environment_name: production
+  expiration: 2016-05-10 13:44:57.080364 -07:00

data/spec/fixtures/sample_manifest.pp

@@ -0,0 +1,2 @@
+$var1 = 'test'
+file{"/tmp/${var1}.txt": ensure => present, mode => '0755'}

data/spec/fixtures/sample_start_debugger.pp

@@ -0,0 +1,13 @@
+class sample_test_breakpoint(
+
+) {
+
+  include stdlib
+  file{'/tmp/test':
+    ensure => present,
+  }
+  range(1,5).map | $num | {
+    start_repl()
+  }
+}
+include sample_test_breakpoint

data/spec/pdb_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'pdb' do
+  let(:fixtures_file) do
+    File.join(fixtures_dir, 'sample_manifest.pp')
+  end
+
+  before(:each) do
+    allow(PuppetDebugger).to receive(:fetch_url_data).with(file_url).and_return(File.read(fixtures_file))
+  end
+
+  let(:file_url) do
+    'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw'
+  end
+
+  it do
+    expect(`echo 'file{"/tmp/test":}'| bundle exec bin/pdb`)
+      .to match(/Puppet::Type::File/)
+  end
+
+  it do
+    expect(`bundle exec bin/pdb #{fixtures_file} --run-once`)
+      .to match(/Puppet::Type::File/)
+  end
+  it do
+    expect(`bundle exec bin/pdb --play #{fixtures_file} --run-once`)
+      .to match(/Puppet::Type::File/)
+  end
+  # xit do
+  #   # this test does not work without internet, and I am at 30K feet right now
+  #   expect(`bundle exec bin/pdb --play #{file_url} --run-once`)
+  #     .to match(/Puppet::Type::File/)
+  # end
+
+  describe 'remote_node' do
+    let(:node_obj) do
+      YAML.load_file(File.join(fixtures_dir, 'node_obj.yaml'))
+    end
+    let(:node_name) do
+      'puppetdev.localdomain'
+    end
+    before :each do
+      allow(PuppetDebugger).to receive(:get_remote_node).with(node_name).and_return(node_obj)
+    end
+    # xit do
+    #   expect(`echo 'vars'| bundle exec bin/pdb -n #{node_name}`)
+    #     .to match(/server_facts/)
+    # end
+  end
+end