Extract common ChefFS file code

2 files changed, 248 insertions, 0 deletions

diff --git a/lib/chef/chef_fs/file_system/repository/base_file.rb b/lib/chef/chef_fs/file_system/repository/base_file.rb
new file mode 100644
index 0000000000..d5ef26887e
--- /dev/null
+++ b/lib/chef/chef_fs/file_system/repository/base_file.rb
@@ -0,0 +1,120 @@
+#
+# Author:: Thom May (<thom@chef.io>)
+# Copyright:: Copyright 2013-2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  module ChefFS
+    module FileSystem
+      module Repository
+
+        class BaseFile
+
+          attr_reader :name
+          attr_reader :parent
+          attr_reader :path
+          attr_reader :file_path
+          attr_reader :data_handler
+
+          def initialize(name, parent)
+            @parent = parent
+            @name = name
+            @path = Chef::ChefFS::PathUtils.join(parent.path, name)
+            @file_path = "#{parent.file_path}/#{name}"
+          end
+
+          def dir?
+            false
+          end
+
+          def is_json_file?
+            File.extname(name) == ".json"
+          end
+
+          def name_valid?
+            !name.start_with?(".") && is_json_file?
+          end
+
+          def fs_entry_valid?
+            name_valid? && exists?
+          end
+
+          def create(file_contents)
+            if exists?
+              raise Chef::ChefFS::FileSystem::AlreadyExistsError.new(:create_child, self)
+            else
+              write(file_contents)
+            end
+          end
+
+          def can_have_child?(name, is_dir)
+            false
+          end
+
+          attr_writer :write_pretty_json
+          def write_pretty_json
+            @write_pretty_json.nil? ? root.write_pretty_json : @write_pretty_json
+          end
+
+          def path_for_printing
+            file_path
+          end
+
+          def delete(_)
+            File.delete(file_path)
+          rescue Errno::ENOENT
+            raise Chef::ChefFS::FileSystem::NotFoundError.new(self, $!)
+          end
+
+          def exists?
+            File.file?(file_path)
+          end
+
+          def minimize(content, entry)
+            object = Chef::JSONCompat.parse(content)
+            object = data_handler.normalize(object, entry)
+            object = data_handler.minimize(object, entry)
+            Chef::JSONCompat.to_json_pretty(object)
+          end
+
+          def read
+            File.open(file_path, "rb") { |f| f.read }
+          rescue Errno::ENOENT
+            raise Chef::ChefFS::FileSystem::NotFoundError.new(self, $!)
+          end
+
+          def write(content)
+            if content && write_pretty_json && is_json_file?
+              content = minimize(content, self)
+            end
+            File.open(file_path, "wb") do |file|
+              file.write(content)
+            end
+          end
+
+          def root
+            parent.root
+          end
+
+          def compare_to(other)
+            nil
+          end
+
+        end
+      end
+    end
+  end
+end
diff --git a/spec/unit/chef_fs/file_system/repository/base_file_spec.rb b/spec/unit/chef_fs/file_system/repository/base_file_spec.rb
new file mode 100644
index 0000000000..bb0c267368
--- /dev/null
+++ b/spec/unit/chef_fs/file_system/repository/base_file_spec.rb
@@ -0,0 +1,128 @@
+#
+# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "spec_helper"
+require "chef/chef_fs/file_system/repository/base_file"
+require "chef/chef_fs/file_system/repository/directory"
+require "chef/chef_fs/file_system/base_fs_object"
+require "chef/chef_fs/file_system/exceptions"
+require "chef/chef_fs/file_system/nonexistent_fs_object"
+
+describe Chef::ChefFS::FileSystem::Repository::BaseFile do
+  let(:root) do
+    Chef::ChefFS::FileSystem::BaseFSDir.new("", nil)
+  end
+
+  let(:tmp_dir) { Dir.mktmpdir }
+
+  let(:parent) do
+    Chef::ChefFS::FileSystem::Repository::Directory.new("test", root, tmp_dir)
+  end
+
+  let(:file) do
+    file = described_class.new("test_file.json", parent)
+    file.write_pretty_json = false
+    file
+  end
+
+  let(:content) { '"name": "canteloup"' }
+  let(:file_path) { File.join(tmp_dir, "test_file.json") }
+
+  after do
+    FileUtils.rm_f(file_path)
+  end
+
+  context "#is_json_file?" do
+    it "returns false when the file is not json" do
+      file = described_class.new("test_file.dpkg", parent)
+      expect(file.is_json_file?).to be_falsey
+    end
+
+    it "returns true when the file is json" do
+      expect(file.is_json_file?).to be_truthy
+    end
+  end
+
+  context "#name_valid?" do
+    it "rejects dotfiles" do
+      file = described_class.new(".test_file.json", parent)
+      expect(file.name_valid?).to be_falsey
+    end
+
+    it "rejects non json files" do
+      file = described_class.new("test_file.dpkg", parent)
+      expect(file.name_valid?).to be_falsey
+    end
+
+    it "allows correctly named files" do
+      expect(file.name_valid?).to be_truthy
+    end
+  end
+
+  context "#fs_entry_valid?" do
+    it "rejects invalid names" do
+      file = described_class.new("test_file.dpkg", parent)
+      expect(file.fs_entry_valid?).to be_falsey
+    end
+
+    it "rejects missing files" do
+      FileUtils.rm_f(file_path)
+      expect(file.fs_entry_valid?).to be_falsey
+    end
+
+    it "allows present and properly named files" do
+      FileUtils.touch(file_path)
+      expect(file.fs_entry_valid?).to be_truthy
+    end
+  end
+
+  context "#create" do
+    it "doesn't create an existing file" do
+      FileUtils.touch(file_path)
+      expect { file.create('"name": "canteloup"') }.to raise_error(Chef::ChefFS::FileSystem::AlreadyExistsError)
+    end
+
+    it "creates a new file" do
+      expect(file).to receive(:write).with(content)
+      expect { file.create(content) }.to_not raise_error
+    end
+
+  end
+
+  context "#write" do
+    context "minimises a json object" do
+      it "not if pretty json is off" do
+        expect(file).to_not receive(:minimize)
+        file.write(content)
+      end
+
+      it "not if it's not a json file" do
+        file = described_class.new("test_file.dpkg", parent)
+        file.write_pretty_json = true
+        expect(file).to_not receive(:minimize)
+        file.write(content)
+      end
+
+      it "correctly" do
+        file = described_class.new("test_file.json", parent)
+        file.write_pretty_json = true
+        expect(file).to receive(:minimize).with(content, file).and_return(content)
+        file.write(content)
+      end
+    end
+  end
+end