Issuing warnings using logger

Glyn Normington · Glyn Normington · commit 5b6b5a35bb7d · 2013-07-29T15:19:40.000+01:00
Fix the corresponding testcase to clear buildpack.log before each
test and check the log for the required output.

[#54192868]
diff --git a/lib/java_buildpack/diagnostics/common.rb b/lib/java_buildpack/diagnostics/common.rb
@@ -28,4 +28,8 @@ def self.get_diagnostic_directory(app_dir)
     File.join(app_dir, DIAGNOSTICS_DIRECTORY)
   end
 
+  def self.get_buildpack_log(app_dir)
+    File.join(get_diagnostic_directory(app_dir), LOG_FILE_NAME)
+  end
+
 end
diff --git a/lib/java_buildpack/jre/memory/weight_balancing_memory_heuristic.rb b/lib/java_buildpack/jre/memory/weight_balancing_memory_heuristic.rb
@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'java_buildpack/diagnostics/logger_factory'
 require 'java_buildpack/jre'
 require 'java_buildpack/jre/memory/memory_limit'
 require 'java_buildpack/jre/memory/memory_size'
@@ -34,6 +35,7 @@ class WeightBalancingMemoryHeuristic
     # @param [Array<String>] valid_heuristics the valid heuristics keys
     # @param [Hash<String, String>] java_opts a mapping from a memory type to a +JAVA_OPTS+ option
     def initialize(sizes, heuristics, valid_sizes, valid_heuristics, java_opts)
+      @logger = JavaBuildpack::Diagnostics::LoggerFactory.get_logger
       validate 'size', valid_sizes, sizes.keys
       validate 'heuristic', valid_heuristics, heuristics.keys
 
@@ -112,7 +114,7 @@ def create_memory_buckets(sizes, heuristics, memory_limit)
       def issue_memory_wastage_warning(buckets)
         native_bucket = buckets['native']
         if native_bucket && native_bucket.size > native_bucket.default_size * NATIVE_MEMORY_WARNING_FACTOR
-          $stderr.puts "-----> WARNING: there is #{NATIVE_MEMORY_WARNING_FACTOR} times more spare native memory than the default, so configured Java memory may be too small."
+          @logger.warn "There is #{NATIVE_MEMORY_WARNING_FACTOR} times more spare native memory than the default, so configured Java memory may be too small."
         end
       end
 
@@ -137,7 +139,7 @@ def issue_close_to_default_warnings(buckets, heuristics, memory_limit)
                 factor = ((actual_size - default_size) / default_size).abs
               end
               if (default_size == MemorySize::ZERO && actual_size == MemorySize::ZERO) || factor < CLOSE_TO_DEFAULT_FACTOR
-                $stderr.puts "-----> WARNING: the configured value #{actual_size} of memory size #{type} is close to the default value #{default_size}. Consider deleting the configured value and taking the default."
+                @logger.warn "The configured value #{actual_size} of memory size #{type} is close to the default value #{default_size}. Consider deleting the configured value and taking the default."
               end
             end
           end
diff --git a/spec/java_buildpack/jre/memory/weight_balancing_memory_heuristic_spec.rb b/spec/java_buildpack/jre/memory/weight_balancing_memory_heuristic_spec.rb
@@ -15,6 +15,8 @@
 # limitations under the License.
 
 require 'spec_helper'
+require 'java_buildpack/diagnostics/common'
+require 'java_buildpack/diagnostics/logger_factory'
 require 'java_buildpack/jre/memory/weight_balancing_memory_heuristic'
 
 module JavaBuildpack::Jre
@@ -44,7 +46,9 @@ module JavaBuildpack::Jre
     VALID_SIZES = %w(heap permgen stack)
 
     before do
-      $stderr = StringIO.new
+      File.delete(JavaBuildpack::Diagnostics.get_buildpack_log Dir.tmpdir)
+      JavaBuildpack::Diagnostics::LoggerFactory.send :close # suppress warnings
+      JavaBuildpack::Diagnostics::LoggerFactory.create_logger Dir.tmpdir
     end
 
     it 'should fail if a memory limit is negative' do
@@ -182,28 +186,28 @@ module JavaBuildpack::Jre
         expect(output).to include('-Xmx1M')
         expect(output).to include('-XX:MaxPermSize=1M')
         expect(output).to include('-Xss2M')
-        expect($stderr.string).to match(/WARNING:/)
+        expect(buildpack_log_contents).to match(/WARN/)
       end
     end
 
     it 'should issue a warning when the specified stack size is close to the default' do
       with_memory_limit('4096m') do
         WeightBalancingMemoryHeuristic.new({ 'stack' => '1025k' }, TEST_WEIGHTINGS, VALID_SIZES, VALID_HEURISTICS, JAVA_OPTS).resolve
-        expect($stderr.string).to match(/WARNING:.*close to the default/)
+        expect(buildpack_log_contents).to match(/WARN.*is close to the default/)
       end
     end
 
     it 'should issue a warning when the specified maximum heap size is close to the default' do
       with_memory_limit('4096m') do
         WeightBalancingMemoryHeuristic.new({ 'heap' => '2049m' }, TEST_WEIGHTINGS, VALID_SIZES, VALID_HEURISTICS, JAVA_OPTS).resolve
-        expect($stderr.string).to match(/WARNING:.*close to the default/)
+        expect(buildpack_log_contents).to match(/WARN.*is close to the default/)
       end
     end
 
     it 'should issue a warning when the specified maximum permgen size is close to the default' do
       with_memory_limit('4096m') do
         WeightBalancingMemoryHeuristic.new({ 'permgen' => '1339m' }, TEST_WEIGHTINGS, VALID_SIZES, VALID_HEURISTICS, JAVA_OPTS).resolve
-        expect($stderr.string).to match(/WARNING:.*close to the default/)
+        expect(buildpack_log_contents).to match(/WARN.*is close to the default/)
       end
     end
 
@@ -229,6 +233,10 @@ def with_memory_limit(memory_limit)
       ENV['MEMORY_LIMIT'] = previous_value
     end
 
+    def buildpack_log_contents
+      File.read(JavaBuildpack::Diagnostics.get_buildpack_log(Dir.tmpdir))
+    end
+
   end
 
 end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -33,5 +33,6 @@
 require 'java_buildpack/diagnostics/common'
 require 'java_buildpack/diagnostics/logger_factory'
 tmpdir = Dir.tmpdir
-FileUtils.rm_rf File.join(tmpdir, JavaBuildpack::Diagnostics::DIAGNOSTICS_DIRECTORY)
+diagnostics_directory = File.join(tmpdir, JavaBuildpack::Diagnostics::DIAGNOSTICS_DIRECTORY)
+FileUtils.rm_rf diagnostics_directory
 JavaBuildpack::Diagnostics::LoggerFactory.create_logger tmpdir
