File: climate_control_spec.rb

package info (click to toggle)
ruby-climate-control 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 140 kB
  • sloc: ruby: 374; makefile: 4
file content (221 lines) | stat: -rw-r--r-- 5,760 bytes parent folder | download
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
require "spec_helper"

Thing = Class.new

describe "Climate control" do
  it "allows modification of the environment" do
    block_run = false
    with_modified_env FOO: "bar" do
      expect(ENV["FOO"]).to eq "bar"
      block_run = true
    end

    expect(ENV["FOO"]).to be_nil
    expect(block_run).to be true
  end

  it "modifies the environment" do
    with_modified_env VARIABLE_1: "bar", VARIABLE_2: "qux" do
      expect(ENV["VARIABLE_1"]).to eq "bar"
      expect(ENV["VARIABLE_2"]).to eq "qux"
    end

    expect(ENV["VARIABLE_1"]).to be_nil
    expect(ENV["VARIABLE_2"]).to be_nil
  end

  it "allows for environment variables to be assigned within the block" do
    with_modified_env VARIABLE_1: "modified" do
      ENV["ASSIGNED_IN_BLOCK"] = "assigned"
    end

    expect(ENV["ASSIGNED_IN_BLOCK"]).to eq "assigned"
  end

  it "reassigns previously set environment variables" do
    ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"] = "original"
    expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "original"

    with_modified_env VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV: "overridden" do
      expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "overridden"
    end

    expect(ENV["VARIABLE_ASSIGNED_BEFORE_MODIFYING_ENV"]).to eq "original"
  end

  it "persists the change when overriding the variable in the block" do
    with_modified_env VARIABLE_MODIFIED_AND_THEN_ASSIGNED: "modified" do
      ENV["VARIABLE_MODIFIED_AND_THEN_ASSIGNED"] = "assigned value"
    end

    expect(ENV["VARIABLE_MODIFIED_AND_THEN_ASSIGNED"]).to eq "assigned value"
  end

  it "resets environment variables even if the block raises" do
    expect {
      with_modified_env FOO: "bar" do
        raise "broken"
      end
    }.to raise_error("broken")

    expect(ENV["FOO"]).to be_nil
  end

  it "preserves environment variables set within the block" do
    ENV["CHANGED"] = "old value"

    with_modified_env IRRELEVANT: "ignored value" do
      ENV["CHANGED"] = "new value"
    end

    expect(ENV["CHANGED"]).to eq "new value"
  end

  it "returns the value of the block" do
    value = with_modified_env VARIABLE_1: "bar" do
      "value inside block"
    end

    expect(value).to eq "value inside block"
  end

  it "handles threads correctly" do
    # failure path without mutex
    # [thread_removing_env] BAZ is assigned
    # 0.25s passes
    # [other_thread] FOO is assigned and ENV is copied (which includes BAZ)
    # 0.25s passes
    # [thread_removing_env] thread resolves and BAZ is removed from env; other_thread still retains knowledge of BAZ
    # 0.25s passes
    # [other_thread] thread resolves, FOO is removed, BAZ is copied back to ENV

    thread_removing_env = Thread.new {
      with_modified_env BAZ: "buzz" do
        sleep 0.5
      end

      expect(ENV["BAZ"]).to be_nil
    }

    other_thread = Thread.new {
      sleep 0.25
      with_modified_env FOO: "bar" do
        sleep 0.5
      end

      expect(ENV["FOO"]).to be_nil
    }

    thread_removing_env.join
    other_thread.join

    expect(ENV["FOO"]).to be_nil
    expect(ENV["BAZ"]).to be_nil
  end

  it "handles threads accessing the same key wrapped in a block" do
    first_thread = Thread.new {
      with_modified_env do
        with_modified_env CONFLICTING_KEY: "1" do
          sleep 0.5
          expect(ENV["CONFLICTING_KEY"]).to eq("1")
        end

        expect(ENV["CONFLICTING_KEY"]).to be_nil
      end
    }

    second_thread = Thread.new {
      with_modified_env do
        sleep 0.25
        expect(ENV["CONFLICTING_KEY"]).to be_nil

        with_modified_env CONFLICTING_KEY: "2" do
          expect(ENV["CONFLICTING_KEY"]).to eq("2")
          sleep 0.5
          expect(ENV["CONFLICTING_KEY"]).to eq("2")
        end

        expect(ENV["CONFLICTING_KEY"]).to be_nil
      end
    }

    first_thread.join
    second_thread.join

    expect(ENV["CONFLICTING_KEY"]).to be_nil
  end

  it "is re-entrant" do
    ret = with_modified_env(FOO: "foo") {
      with_modified_env(BAR: "bar") do
        "bar"
      end
    }

    expect(ret).to eq("bar")

    expect(ENV["FOO"]).to be_nil
    expect(ENV["BAR"]).to be_nil
  end

  it "raises when the value cannot be assigned properly" do
    message = generate_type_error_for_object(Thing.new)

    expect {
      with_modified_env(FOO: Thing.new)
    }.to raise_error ClimateControl::UnassignableValueError, /attempted to assign .*Thing.* to FOO but failed \(#{message}\)$/
  end

  it "restores the ENV even when an error was raised when assigning values" do
    ENV["KEY_TO_OVERRIDE"] = "initial_value_1"
    ENV["KEY_THAT_WILL_ERROR_OUT"] = "initial_value_2"

    expect {
      with_modified_env(
        KEY_TO_OVERRIDE: "overwriten_value_1",
        KEY_THAT_WILL_ERROR_OUT: :value_that_will_error_out
      ) {}
    }.to raise_error ClimateControl::UnassignableValueError

    expect(ENV["KEY_TO_OVERRIDE"]).to eq("initial_value_1")
    expect(ENV["KEY_THAT_WILL_ERROR_OUT"]).to eq("initial_value_2")
  end

  it "doesn't block on nested modify calls" do
    with_modified_env(SMS_DEFAULT_COUNTRY_CODE: nil) do
      with_modified_env(SMS_DEFAULT_COUNTRY_CODE: "++56") do
        expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++56")
      end

      expect(ENV.fetch("SMS_DEFAULT_COUNTRY_CODE", "++41")).to eq("++41")
    end
  end

  def with_modified_env(options = {}, &block)
    ClimateControl.modify(options, &block)
  end

  def generate_type_error_for_object(object)
    message = nil

    begin
      "1" + object
    rescue TypeError => e
      message = e.message
    end

    message
  end

  around do |example|
    old_env = ENV.to_hash

    example.run

    ENV.clear
    old_env.each do |key, value|
      ENV[key] = value
    end
  end
end