Merge pull request #5551 from inspec/vasundhara/fix-mysql-session-resource

Fix mysql_session resource to raise exception if there is a error in connection or in query

lib/inspec/resources/mysql_session.rb

@@ -44,10 +44,14 @@ module Inspec::Resources
       @port = port
       @socket = socket
       init_fallback if user.nil? || pass.nil?
-      skip_resource("Can't run MySQL SQL checks without authentication") if @user.nil? || @pass.nil?
+      raise Inspec::Exceptions::ResourceFailed, "Can't run MySQL SQL checks without authentication." if @user.nil? || @pass.nil?
+
+      test_connection
     end
 
     def query(q, db = "")
+      raise Inspec::Exceptions::ResourceFailed, "#{resource_exception_message}" if resource_failed?
+
       mysql_cmd = create_mysql_cmd(q, db)
       cmd = if !@pass.nil?
               inspec.command(mysql_cmd, redact_regex: /(mysql -u\w+ -p).+(\s-(h|S).*)/)
@@ -56,7 +60,7 @@ module Inspec::Resources
             end
       out = cmd.stdout + "\n" + cmd.stderr
       if cmd.exit_status != 0 || out =~ /Can't connect to .* MySQL server/ || out.downcase =~ /^error:.*/
-        Lines.new(out, "MySQL query with errors: #{q}", cmd.exit_status)
+        raise Inspec::Exceptions::ResourceFailed, "MySQL query with errors: #{out}"
       else
         Lines.new(cmd.stdout.strip, "MySQL query: #{q}", cmd.exit_status)
       end
@@ -68,6 +72,12 @@ module Inspec::Resources
 
     private
 
+    # Querying on the database to make sure conneciton can be established. If not this will set the resource exception
+    # message which we raise before querying on the database using mysql_session object.
+    def test_connection
+      query("select now()")
+    end
+
     def escape_string(query)
       Shellwords.escape(query)
     end

test/fixtures/profiles/skippy-controls/controls/skipper.rb

@@ -3,9 +3,3 @@ control 'CONTROL super' do
     skip 'This will be skipped super intentionally.'
   end
 end
-
-control 'CONTROL database' do
-  describe mysql_session do
-    its('something') { should be 3 }
-  end
-end

test/functional/inspec_exec_junit_test.rb

@@ -97,7 +97,7 @@ describe "inspec exec with junit formatter" do
         _(run_result.stderr).must_equal ""
         _(schema.validate(doc)).must_be_empty
         suite = doc.xpath("//testsuite").first
-        _(suite.attr("skipped")).must_equal "2"
+        _(suite.attr("skipped")).must_equal "1"
         testcase = doc.xpath("//testcase").first
         _(testcase.xpath("//skipped")).wont_be_empty
       end

test/functional/inspec_exec_test.rb

@@ -299,8 +299,7 @@ Test Summary: 0 successful, 0 failures, 0 skipped
 
     it "exits with an error" do
       _(stdout).must_include "skippy\n     ↺  This will be skipped super intentionally.\n"
-      _(stdout).must_include "  ↺  CONTROL database: MySQL Session\n     ↺  Can't run MySQL SQL checks without authentication\n"
-      _(stdout).must_include "Profile Summary: 0 successful controls, 0 control failures, 2 controls skipped\nTest Summary: 0 successful, 0 failures, 2 skipped\n"
+      _(stdout).must_include "Profile Summary: 0 successful controls, 0 control failures, 1 control skipped\nTest Summary: 0 successful, 0 failures, 1 skipped\n"
 
       _(stderr).must_equal ""
 
@@ -312,7 +311,7 @@ Test Summary: 0 successful, 0 failures, 0 skipped
     let(:out) { inspec("exec " + File.join(profile_path, "skippy-controls") + " --no-distinct-exit --no-create-lockfile") }
 
     it "exits with code 0 and skipped tests in output" do
-      _(stdout).must_include "Profile Summary: 0 successful controls, 0 control failures, 2 controls skipped\nTest Summary: 0 successful, 0 failures, 2 skipped\n"
+      _(stdout).must_include "Profile Summary: 0 successful controls, 0 control failures, 1 control skipped\nTest Summary: 0 successful, 0 failures, 1 skipped\n"
 
       _(stderr).must_equal ""
 

test/unit/resources/mysql_session_test.rb

@@ -26,4 +26,15 @@ describe "Inspec::Resources::MysqlSession" do
     expected_to_s = %q{Command: `mysql -uroot -pREDACTED -h localhost -s -e "SELECT 1 FROM DUAL;"`}
     _(resource.to_s).must_equal(expected_to_s)
   end
+  it "fails when no user, password" do
+    resource = load_resource("mysql_session", nil, nil, "localhost", 3306)
+    _(resource.resource_failed?).must_equal true
+    _(resource.resource_exception_message).must_equal "Can't run MySQL SQL checks without authentication."
+  end
+  it "fails when no connection established" do
+    resource = load_resource("mysql_session", "root", "root", "localhost", 3306)
+    _(resource.resource_failed?).must_equal true
+    _(resource.resource_exception_message).must_include "MySQL query with errors"
+  end
+
 end