summaryrefslogtreecommitdiff
path: root/spec/unit/json_compat_spec.rb
blob: 2d196ea29a60427578e3ae349bc8f6ea7dfcb975 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
#
# Author:: Juanje Ojeda (<juanje.ojeda@gmail.com>)
# Copyright:: Copyright 2012-2016, Opscode, 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 File.expand_path("../../spec_helper", __FILE__)
require "chef/json_compat"

describe Chef::JSONCompat do
  before { Chef::Config[:treat_deprecation_warnings_as_errors] = false }

  describe "#from_json with JSON containing an existing class" do
    let(:json) { '{"json_class": "Chef::Role"}' }

    it "emits a deprecation warning" do
      Chef::Config[:treat_deprecation_warnings_as_errors] = true
      expect { Chef::JSONCompat.from_json(json) }.to raise_error Chef::Exceptions::DeprecatedFeatureError,
        /Auto inflation of JSON data is deprecated. Please use Chef::Role#from_hash/
    end

    it "returns an instance of the class instead of a Hash" do
      expect(Chef::JSONCompat.from_json(json).class).to eq Chef::Role
    end
  end

  describe "#from_json with JSON containing comments" do
    let(:json) { %Q{{\n/* comment */\n// comment 2\n"json_class": "Chef::Role"}} }

    it "returns an instance of the class instead of a Hash" do
      expect(Chef::JSONCompat.from_json(json).class).to eq Chef::Role
    end
  end

  describe "#parse with JSON containing comments" do
    let(:json) { %Q{{\n/* comment */\n// comment 2\n"json_class": "Chef::Role"}} }

    it "returns a Hash" do
      expect(Chef::JSONCompat.parse(json).class).to eq Hash
    end
  end

  describe 'with JSON containing "Chef::Sandbox" as a json_class value' do
    require "chef/sandbox" # Only needed for this test

    let(:json) { '{"json_class": "Chef::Sandbox", "arbitrary": "data"}' }

    it "returns a Hash, because Chef::Sandbox is a dummy class" do
      expect(Chef::JSONCompat.from_json(json)).to eq({"json_class" => "Chef::Sandbox", "arbitrary" => "data"})
    end
  end

  describe "when pretty printing an object that defines #to_json" do
    class Foo
      def to_json(*a)
        Chef::JSONCompat.to_json({"foo" => 1234, "bar" => {"baz" => 5678}}, *a)
      end
    end

    it "should work" do
      f = Foo.new
      expect(Chef::JSONCompat.to_json_pretty(f)).to eql("{\n  \"foo\": 1234,\n  \"bar\": {\n    \"baz\": 5678\n  }\n}\n")
    end

    include_examples "to_json equivalent to Chef::JSONCompat.to_json" do
      let(:jsonable) { Foo.new }
    end
  end

  describe "with the file with 252 or less nested entries" do
    let(:json) { IO.read(File.join(CHEF_SPEC_DATA, "nested.json")) }
    let(:hash) { Chef::JSONCompat.from_json(json) }

    describe "when the 252 json file is loaded" do
      it "should create a Hash from the file" do
        expect(hash).to be_kind_of(Hash)
      end

      it "should has 'test' as a 252 nested value" do
        v = 252.times.inject(hash) do |memo, _|
          memo["key"]
        end
        expect(v).to eq("test")
      end
    end
  end

  it "should define .to_json on all classes" do
    class SomeClass; end

    expect(SomeClass.new.respond_to?(:to_json)).to eq(true)
  end
end