linux_admin 0.1.3 → 0.2.0

data/lib/linux_admin/yum.rb

@@ -14,7 +14,7 @@ class LinuxAdmin
       params["--database"]            = nil  if options[:database]
       params["--unique-md-filenames"] = nil  if options[:unique_file_names]
 
-      run(cmd, :params => params)
+      run!(cmd, :params => params)
     end
 
     def self.download_packages(path, packages, options = {})
@@ -32,7 +32,7 @@ class LinuxAdmin
       params["-a"]  = options[:arch] if options[:arch]
       params[nil]   = packages
 
-      run(cmd, :params => params)
+      run!(cmd, :params => params)
     end
 
     def self.repo_settings
@@ -43,7 +43,7 @@ class LinuxAdmin
       cmd    = "yum check-update"
       params = {nil => packages} unless packages.blank?
 
-      exitstatus = run(cmd, :params => params, :return_exitstatus => true)
+      exitstatus = run(cmd, :params => params).exit_status
       case exitstatus
       when 0;   false
       when 100; true
@@ -55,7 +55,7 @@ class LinuxAdmin
       cmd    = "yum -y update"
       params = {nil => packages} unless packages.blank?
 
-      run(cmd, :params => params)
+      run!(cmd, :params => params)
     end
 
     def self.version_available(*packages)
@@ -64,7 +64,7 @@ class LinuxAdmin
       cmd    = "repoquery --qf=\"%{name} %{version}\""
       params = {nil => packages}
 
-      out = run(cmd, :params => params, :return_output => true)
+      out = run!(cmd, :params => params).output
 
       items = out.split("\n")
       items.each_with_object({}) do |i, versions|

data/spec/common_spec.rb

@@ -30,85 +30,115 @@ describe LinuxAdmin::Common do
   context ".cmd" do
     it "looks up local command from id" do
       d = double(LinuxAdmin::Distro)
-      d.class::COMMANDS = { :sh => '/bin/sh' }
+      d.class::COMMANDS = {:sh => '/bin/sh'}
       LinuxAdmin::Distro.should_receive(:local).and_return(d)
       subject.cmd(:sh).should == '/bin/sh'
     end
   end
 
-  context ".run" do
+  shared_examples_for "run" do
     context "with params" do
+      before do
+        subject.stub(:exitstatus => 0)
+      end
+
       it "sanitizes crazy params" do
         subject.should_receive(:launch).once.with("true --user bob --pass P@\\$sw0\\^\\&\\ \\|\\<\\>/-\\+\\*d\\% --db --desc=Some\\ Description pkg1 some\\ pkg --pool 123 --pool 456", {})
-        subject.run("true", :params => modified_params, :return_exitstatus => true)
+        subject.send(run_method, "true", :params => modified_params)
       end
 
       it "as empty hash" do
         subject.should_receive(:launch).once.with("true", {})
-        subject.run("true", :params => {}, :return_exitstatus => true)
+        subject.send(run_method, "true", :params => {})
       end
 
       it "as nil" do
         subject.should_receive(:launch).once.with("true", {})
-        subject.run("true", :params => nil, :return_exitstatus => true)
+        subject.send(run_method, "true", :params => nil)
       end
 
       it "won't modify caller params" do
         orig_params = params.dup
-        subject.run("true", :params => params, :return_exitstatus => true)
+        subject.stub(:launch)
+        subject.send(run_method, "true", :params => params)
         expect(orig_params).to eq(params)
       end
+
+      it "supports spawn's chdir option" do
+        subject.should_receive(:launch).once.with("true", {:chdir => ".."})
+        subject.send(run_method, "true", :chdir => "..")
+      end
     end
 
     context "with real execution" do
       before do
-        Kernel.should_receive(:spawn).and_call_original
+        Kernel.stub(:spawn).and_call_original
       end
 
       it "command ok exit ok" do
-        expect(subject.run("true")).to be_true
+        expect(subject.send(run_method, "true")).to be_kind_of CommandResult
       end
 
       it "command ok exit bad" do
-        expect { subject.run("false") }.to raise_error(CommandError)
+        if run_method == "run!"
+          error = nil
+
+          # raise_error with do/end block notation is broken in rspec-expectations 2.14.x
+          # and has been fixed in master but not yet released.
+          # See: https://github.com/rspec/rspec-expectations/commit/b0df827f4c12870aa4df2f20a817a8b01721a6af
+          expect {subject.send(run_method, "false")}.to raise_error {|e| error = e }
+          expect(error).to be_kind_of CommandResultError
+          expect(error.result).to be_kind_of CommandResult
+        else
+          expect {subject.send(run_method, "false")}.to_not raise_error
+        end
       end
 
       it "command bad" do
-        expect { subject.run("XXXXX") }.to raise_error(Errno::ENOENT)
+        expect {subject.send(run_method, "XXXXX")}.to raise_error(Errno::ENOENT)
       end
 
-      context "with :return_exitstatus => true" do
+      context "#exit_status" do
         it "command ok exit ok" do
-          expect(subject.run("true", :return_exitstatus => true)).to eq(0)
+          expect(subject.send(run_method, "true").exit_status).to eq(0)
         end
 
         it "command ok exit bad" do
-          expect(subject.run("false", :return_exitstatus => true)).to eq(1)
-        end
-
-        it "command bad" do
-          expect(subject.run("XXXXX", :return_exitstatus => true)).to be_nil
+          expect(subject.send(run_method, "false").exit_status).to eq(1) if run_method == "run"
         end
       end
 
-      context "with :return_output => true" do
+      context "#output" do
         it "command ok exit ok" do
-          expect(subject.run("echo \"Hello World\"", :return_output => true)).to eq("Hello World\n")
+          expect(subject.send(run_method, "echo \"Hello World\"").output).to eq("Hello World\n")
         end
 
         it "command ok exit bad" do
-          expect { subject.run("false", :return_output => true) }.to raise_error(CommandError)
+          expect(subject.send(run_method, "echo 'bad' && false").output).to eq("bad\n") if run_method == "run"
         end
+      end
 
-        it "command bad" do
-          expect { subject.run("XXXXX", :return_output => true) }.to raise_error(Errno::ENOENT)
+      context "#error" do
+        it "command ok exit ok" do
+          expect(subject.send(run_method, "echo \"Hello World\" >&2").error).to eq("Hello World\n")
+        end
+
+        it "command ok exit bad" do
+          expect(subject.send(run_method, "echo 'bad' >&2 && false").error).to eq("bad\n") if run_method == "run"
         end
       end
     end
+  end
+
+  context ".run" do
+    include_examples "run" do
+      let(:run_method) {"run"}
+    end
+  end
 
-    it "supports spawn's chdir option" do
-      subject.should_receive(:launch).once.with("true", {:chdir => ".."})
-      subject.run("true", :chdir => "..", :return_exitstatus => true)
+  context ".run!" do
+    include_examples "run" do
+      let(:run_method) {"run!"}
     end
   end
 end

data/spec/disk_spec.rb

@@ -15,11 +15,10 @@ describe LinuxAdmin::Disk do
   describe "#size" do
     it "uses fdisk" do
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
-      disk.should_receive(:run).
+      disk.should_receive(:run!).
         with(disk.cmd(:fdisk),
-             :return_output => true,
              :params => {"-l" => nil}).
-        and_return("")
+        and_return(double(:output => ""))
       disk.size
     end
 
@@ -39,7 +38,7 @@ Disk identifier: 0x3ddb508b
 eos
 
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
-      disk.stub(:run).and_return(fdisk)
+      disk.stub(:run!).and_return(double(:output => fdisk))
       disk.size.should == 500.1.gigabytes
     end
   end
@@ -49,9 +48,7 @@ eos
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
       disk.should_receive(:run).
         with(disk.cmd(:parted),
-             :return_exitstatus => true,
-             :return_output => true,
-             :params => { nil => ['/dev/hda', 'print'] }).and_return ""
+             :params => { nil => ['/dev/hda', 'print'] }).and_return(double(:output => ""))
       disk.partitions
     end
 
@@ -76,7 +73,7 @@ Number  Start   End     Size    Type      File system     Flags
  3      162GB   163GB   1074MB  logical   linux-swap(v1)
 eos
       disk = LinuxAdmin::Disk.new
-      disk.should_receive(:run).and_return(partitions)
+      disk.should_receive(:run).and_return(double(:output => partitions))
 
       disk.partitions[0].id.should == 1
       disk.partitions[0].disk.should == disk
@@ -112,32 +109,32 @@ eos
     end
 
     it "uses parted" do
-      @disk.should_receive(:run).
+      @disk.should_receive(:run!).
         with(@disk.cmd(:parted),
              :params => { nil => ['/dev/hda', 'mkpart', 'primary', 1024, 2048] })
       @disk.create_partition 'primary', 1024
     end
 
     it "returns partition" do
-      @disk.should_receive(:run) # stub out call to parted
+      @disk.should_receive(:run!) # stub out call to parted
       partition = @disk.create_partition 'primary', 1024
       partition.should be_an_instance_of(LinuxAdmin::Partition)
     end
 
     it "increments partition id" do
-      @disk.should_receive(:run) # stub out call to parted
+      @disk.should_receive(:run!) # stub out call to parted
       partition = @disk.create_partition 'primary', 1024
       partition.id.should == 2
     end
 
     it "sets partition start to first unused sector on disk" do
-      @disk.should_receive(:run) # stub out call to parted
+      @disk.should_receive(:run!) # stub out call to parted
       partition = @disk.create_partition 'primary', 1024
       partition.start_sector.should == 1024
     end
 
     it "stores new partition locally" do
-      @disk.should_receive(:run) # stub out call to parted
+      @disk.should_receive(:run!) # stub out call to parted
       lambda {
         @disk.create_partition 'primary', 1024
       }.should change{@disk.partitions.size}.by(1)
@@ -147,15 +144,17 @@ eos
   describe "#clear!" do
     it "clears partitions" do
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
-      disk.stub(:run).and_return("") # stub out call to cmds
+      disk.should_receive(:run).and_return(double(:output => "")) # stub out call to cmds
       disk.partitions << LinuxAdmin::Partition.new
+
+      disk.should_receive(:run!)
       disk.clear!
       disk.partitions.should be_empty
     end
 
     it "uses dd to clear partition table" do
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
-      disk.should_receive(:run).
+      disk.should_receive(:run!).
            with(disk.cmd(:dd),
                 :params => {'if=' => '/dev/zero', 'of=' => '/dev/hda',
                             'bs=' => 512, 'count=' => 1})
@@ -164,7 +163,7 @@ eos
 
     it "returns self" do
       disk = LinuxAdmin::Disk.new :path => '/dev/hda'
-      disk.stub(:run) # stub out call to dd
+      disk.stub(:run!) # stub out call to dd
       disk.clear!.should == disk
     end
   end

data/spec/logical_volume_spec.rb

@@ -25,7 +25,7 @@ eos
     it "uses lvextend" do
       lv = described_class.new :name => 'lv'
       vg = LinuxAdmin::VolumeGroup.new :name => 'vg'
-      lv.should_receive(:run).
+      lv.should_receive(:run!).
          with(vg.cmd(:lvextend),
               :params => ['lv', 'vg'])
       lv.extend_with(vg)
@@ -34,7 +34,7 @@ eos
     it "returns self" do
       lv = described_class.new :name => 'lv'
       vg = LinuxAdmin::VolumeGroup.new :name => 'vg'
-      lv.stub(:run)
+      lv.stub(:run!)
       lv.extend_with(vg).should == lv
     end
   end
@@ -46,7 +46,7 @@ eos
 
     it "uses lvcreate" do
       described_class.instance_variable_set(:@lvs, [])
-      described_class.should_receive(:run).
+      described_class.should_receive(:run!).
                                 with(LinuxAdmin.cmd(:lvcreate),
                                      :params => { '-n' => 'lv',
                                                    nil => 'vg',
@@ -55,16 +55,16 @@ eos
     end
 
     it "returns new logical volume" do
-      LinuxAdmin::VolumeGroup.stub(:run => "")
-      described_class.stub(:run => "")
+      LinuxAdmin::VolumeGroup.stub(:run! => double(:output => ""))
+      described_class.stub(:run! => double(:output => ""))
       lv = described_class.create 'lv', @vg, '256G'
       lv.should be_an_instance_of(described_class)
       lv.name.should == 'lv'
     end
 
     it "adds logical volume to local registry" do
-      LinuxAdmin::VolumeGroup.stub(:run => "")
-      described_class.stub(:run => "")
+      LinuxAdmin::VolumeGroup.stub(:run! => double(:output => ""))
+      described_class.stub(:run! => double(:output => ""))
       lv = described_class.create 'lv', @vg, '256G'
       described_class.scan.should include(lv)
     end
@@ -72,18 +72,17 @@ eos
 
   describe "#scan" do
     it "uses lvdisplay" do
-      described_class.should_receive(:run).
+      described_class.should_receive(:run!).
                                 with(LinuxAdmin.cmd(:lvdisplay),
-                                     :return_output => true,
                                      :params => { '-c' => nil}).
-                                and_return(@logical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups) # stub out call to vgdisplay
+                                and_return(double(:output => @logical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups)) # stub out call to vgdisplay
       described_class.scan
     end
 
     it "returns local logical volumes" do
-      described_class.should_receive(:run).and_return(@logical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups)
+      described_class.should_receive(:run!).and_return(double(:output => @logical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups))
       lvs = described_class.scan
 
       lvs[0].should be_an_instance_of(described_class)
@@ -96,8 +95,8 @@ eos
     end
 
     it "resolves volume group references" do
-      described_class.should_receive(:run).and_return(@logical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups)
+      described_class.should_receive(:run!).and_return(double(:output => @logical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups))
       lvs = described_class.scan
       lvs[0].volume_group.should be_an_instance_of(LinuxAdmin::VolumeGroup)
       lvs[0].volume_group.name.should == 'vg_foobar'

data/spec/partition_spec.rb

@@ -7,7 +7,7 @@ describe LinuxAdmin::Partition do
 
     # stub out calls that modify system
     FileUtils.stub(:mkdir)
-    @partition.stub(:run)
+    @partition.stub(:run!)
   end
 
   describe "#path" do
@@ -18,14 +18,14 @@ describe LinuxAdmin::Partition do
 
   describe "#format_to" do
     it "uses mke2fs" do
-      @partition.should_receive(:run).
+      @partition.should_receive(:run!).
          with(@partition.cmd(:mke2fs),
               :params => { '-t' => 'ext4', nil => '/dev/sda2'})
       @partition.format_to('ext4')
     end
 
     it "sets fs type" do
-      @partition.should_receive(:run) # ignore actual formatting cmd
+      @partition.should_receive(:run!) # ignore actual formatting cmd
       @partition.format_to('ext4')
       @partition.fs_type.should == 'ext4'
     end
@@ -33,7 +33,7 @@ describe LinuxAdmin::Partition do
 
   describe "#mount" do
     it "sets mount point" do
-      @partition.should_receive(:run) # ignore actual mount cmd
+      @partition.should_receive(:run!) # ignore actual mount cmd
       @partition.mount
       @partition.mount_point.should == '/mnt/sda2'
     end
@@ -42,13 +42,13 @@ describe LinuxAdmin::Partition do
       it "creates mountpoint" do
         File.should_receive(:directory?).with('/mnt/sda2').and_return(false)
         FileUtils.should_receive(:mkdir).with('/mnt/sda2')
-        @partition.should_receive(:run) # ignore actual mount cmd
+        @partition.should_receive(:run!) # ignore actual mount cmd
         @partition.mount
       end
     end
 
     it "mounts partition" do
-      @partition.should_receive(:run).
+      @partition.should_receive(:run!).
          with(@partition.cmd(:mount),
               :params => { nil => ['/dev/sda2', '/mnt/sda2']})
       @partition.mount
@@ -58,7 +58,7 @@ describe LinuxAdmin::Partition do
   describe "#umount" do
     it "unmounts partition" do
       @partition.mount_point = '/mnt/sda2'
-      @partition.should_receive(:run).
+      @partition.should_receive(:run!).
          with(@partition.cmd(:umount),
               :params => { nil => ['/mnt/sda2']})
       @partition.umount

data/spec/physical_volume_spec.rb

@@ -24,7 +24,7 @@ eos
     it "uses vgextend" do
       vg = LinuxAdmin::VolumeGroup.new :name => 'vg'
       pv = described_class.new :device_name => '/dev/hda'
-      pv.should_receive(:run).
+      pv.should_receive(:run!).
          with(pv.cmd(:vgextend),
               :params => ['vg', '/dev/hda'])
       pv.attach_to(vg)
@@ -33,7 +33,7 @@ eos
     it "assigns volume group to physical volume" do
       vg = LinuxAdmin::VolumeGroup.new :name => 'vg'
       pv = described_class.new :device_name => '/dev/hda'
-      pv.stub(:run)
+      pv.stub(:run!)
       pv.attach_to(vg)
       pv.volume_group.should == vg
     end
@@ -41,7 +41,7 @@ eos
     it "returns self" do
       vg = LinuxAdmin::VolumeGroup.new :name => 'vg'
       pv = described_class.new :device_name => '/dev/hda'
-      pv.stub(:run)
+      pv.stub(:run!)
       pv.attach_to(vg).should == pv
     end
   end
@@ -56,23 +56,23 @@ eos
 
     it "uses pvcreate" do
       described_class.instance_variable_set(:@pvs, [])
-      described_class.should_receive(:run).
+      described_class.should_receive(:run!).
                                  with(LinuxAdmin.cmd(:pvcreate),
                                       :params => { nil => '/dev/hda'})
       described_class.create disk
     end
 
     it "returns new physical volume" do
-      LinuxAdmin::VolumeGroup.stub(:run => "")
-      described_class.stub(:run => "")
+      LinuxAdmin::VolumeGroup.stub(:run! => double(:output => ""))
+      described_class.stub(:run! => double(:output => ""))
       pv = described_class.create disk
       pv.should be_an_instance_of(described_class)
       pv.device_name.should == '/dev/hda'
     end
 
     it "adds physical volume to local registry" do
-      LinuxAdmin::VolumeGroup.stub(:run => "")
-      described_class.stub(:run => "")
+      LinuxAdmin::VolumeGroup.stub(:run! => double(:output => ""))
+      described_class.stub(:run! => double(:output => ""))
       pv = described_class.create disk
       described_class.scan.should include(pv)
     end
@@ -80,18 +80,17 @@ eos
 
   describe "#scan" do
     it "uses pvdisplay" do
-      described_class.should_receive(:run).
+      described_class.should_receive(:run!).
                                  with(LinuxAdmin.cmd(:pvdisplay),
-                                     :return_output => true,
                                      :params => { '-c' => nil}).
-                                 and_return(@physical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups) # stub out call to vgdisplay
+                                 and_return(double(:output => @physical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups)) # stub out call to vgdisplay
       described_class.scan
     end
 
     it "returns local physical volumes" do
-      described_class.should_receive(:run).and_return(@physical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups)
+      described_class.should_receive(:run!).and_return(double(:output => @physical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups))
       pvs = described_class.scan
 
       pvs[0].should be_an_instance_of(described_class)
@@ -100,8 +99,8 @@ eos
     end
 
     it "resolves volume group references" do
-      described_class.should_receive(:run).and_return(@physical_volumes)
-      LinuxAdmin::VolumeGroup.should_receive(:run).and_return(@groups)
+      described_class.should_receive(:run!).and_return(double(:output => @physical_volumes))
+      LinuxAdmin::VolumeGroup.should_receive(:run!).and_return(double(:output => @groups))
       pvs = described_class.scan
       pvs[0].volume_group.should be_an_instance_of(LinuxAdmin::VolumeGroup)
       pvs[0].volume_group.name.should == 'vg_foobar'