Make sandbox directory on demand

nebhale · nebhale · commit c0b85ca10d80 · 2013-12-24T10:53:03.000Z
Previously, the component sandbox directory was created aggressively
each time a Droplet was instantiated.  This caused issues because it
would happen during the detect phase and corrupt the file system for
the compile phase.  This change removes the aggressive creation and
instead makes the directory the first time that the sandbox is
requested by a component.

[#62947962]
diff --git a/lib/java_buildpack/component/droplet.rb b/lib/java_buildpack/component/droplet.rb
@@ -53,10 +53,6 @@ class Droplet
     #                                                    excludes files in the sandboxes of other components
     attr_reader :root
 
-    # @!attribute [r] sandbox
-    #   @return [Pathname] the root of the component's sandbox
-    attr_reader :sandbox
-
     # Creates a new instance of the droplet abstraction
     #
     # @param [AdditionalLibraries] additional_libraries     the shared +AdditionalLibraries+ instance for all components
@@ -81,7 +77,6 @@ def initialize(additional_libraries, component_id, java_home, java_opts, root)
       @root    = JavaBuildpack::Util::FilteringPathname.new(root,
                                                             ->(path) { !in?(path, buildpack_root) || in?(path, @sandbox) },
                                                             true)
-      FileUtils.mkdir_p @sandbox
     end
 
     # Copy resources from a components resources directory to a directory
@@ -91,13 +86,22 @@ def copy_resources(target_directory = @sandbox)
       resources = RESOURCES_DIRECTORY + @component_id
 
       if resources.exist?
+        FileUtils.mkdir_p target_directory
         FileUtils.cp_r("#{resources}/.", target_directory)
         @logger.debug { "Resources #{resources} found" }
       else
         @logger.debug { "No resources #{resources} found" }
       end
     end
 
+    # Returns the root of the component's sandbox
+    #
+    # @return [Pathname] the root of the component's sandbox
+    def sandbox
+      FileUtils.mkdir_p @sandbox unless @sandbox.exist?
+      @sandbox
+    end
+
     private
 
     RESOURCES_DIRECTORY = Pathname.new(File.expand_path('../../../../resources', __FILE__))
diff --git a/lib/java_buildpack/container/tomcat.rb b/lib/java_buildpack/container/tomcat.rb
@@ -112,7 +112,6 @@ def download_support
 
     def expand(file)
       with_timing "Expanding Tomcat to #{@droplet.sandbox.relative_path_from(@droplet.root)}" do
-        FileUtils.mkdir_p @droplet.sandbox
         shell "tar xzf #{file.path} -C #{@droplet.sandbox} --strip 1 --exclude webapps 2>&1"
 
         @droplet.copy_resources
diff --git a/lib/java_buildpack/framework/new_relic_agent.rb b/lib/java_buildpack/framework/new_relic_agent.rb
@@ -24,7 +24,6 @@ module JavaBuildpack::Framework
   class NewRelicAgent < JavaBuildpack::Component::VersionedDependencyComponent
 
     def compile
-      FileUtils.mkdir_p @droplet.sandbox
       FileUtils.mkdir_p logs_dir
 
       download_jar
diff --git a/lib/java_buildpack/framework/spring_insight.rb b/lib/java_buildpack/framework/spring_insight.rb
@@ -109,8 +109,6 @@ def unpack_agent_installer(root, file)
     end
 
     def install_insight(agent_dir)
-      FileUtils.mkdir_p @droplet.sandbox
-
       root = Pathname.glob(agent_dir + 'springsource-insight-uber-agent-*')[0]
 
       init_container_libs root
diff --git a/spec/java_buildpack/component/droplet_spec.rb b/spec/java_buildpack/component/droplet_spec.rb
@@ -82,4 +82,18 @@
     droplet.copy_resources
   end
 
+  it 'should not initialize sandbox until it is used' do
+    sandbox_dir = app_dir + '.java-buildpack/droplet'
+
+    expect(sandbox_dir).not_to exist
+
+    droplet
+
+    expect(sandbox_dir).not_to exist
+
+    droplet.sandbox
+
+    expect(sandbox_dir).to exist
+  end
+
 end
