prefab-cloud-ruby 0.24.5 → 1.0.0

data/test/support/common_helpers.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module CommonHelpers
+  require 'timecop'
+
+  def setup
+    $oldstderr, $stderr = $stderr, StringIO.new
+
+    $logs = nil
+    Timecop.freeze('2023-08-09 15:18:12 -0400')
+  end
+
+  def teardown
+    if $logs && !$logs.string.empty?
+      raise "Unexpected logs. Handle logs with assert_only_expected_logs or assert_logged\n\n#{$logs.string}"
+    end
+
+    if $stderr != $oldstderr && !$stderr.string.empty?
+      # we ignore 2.X because of the number of `instance variable @xyz not initialized` warnings
+      if !RUBY_VERSION.start_with?('2.')
+        raise "Unexpected stderr. Handle stderr with assert_stderr\n\n#{$stderr.string}"
+      end
+    end
+
+    $stderr = $oldstderr
+
+    Timecop.return
+  end
+
+  def with_env(key, value, &block)
+    old_value = ENV.fetch(key, nil)
+
+    ENV[key] = value
+    block.call
+  ensure
+    ENV[key] = old_value
+  end
+
+  DEFAULT_NEW_CLIENT_OPTIONS = {
+    prefab_config_override_dir: 'none',
+    prefab_config_classpath_dir: 'test',
+    prefab_envs: ['unit_tests'],
+    prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
+  }.freeze
+
+  def new_client(overrides = {})
+    $logs ||= StringIO.new
+
+    config = overrides.delete(:config)
+    project_env_id = overrides.delete(:project_env_id)
+
+    options = Prefab::Options.new(
+      **DEFAULT_NEW_CLIENT_OPTIONS.merge(
+        overrides.merge(logdev: $logs)
+      )
+    )
+
+    Prefab::Client.new(options).tap do |client|
+      inject_config(client, config) if config
+
+      client.resolver.project_env_id = project_env_id if project_env_id
+    end
+  end
+
+  def string_list(values)
+    PrefabProto::ConfigValue.new(string_list: PrefabProto::StringList.new(values: values))
+  end
+
+  def inject_config(client, config)
+    resolver = client.config_client.instance_variable_get('@config_resolver')
+    store = resolver.instance_variable_get('@local_store')
+
+    Array(config).each do |c|
+      store[c.key] = { config: c }
+    end
+  end
+
+  def inject_project_env_id(client, project_env_id)
+    resolver = client.config_client.instance_variable_get('@config_resolver')
+    resolver.project_env_id = project_env_id
+  end
+
+  FakeResponse = Struct.new(:status, :body)
+
+  def wait_for_post_requests(client, max_wait: 2, sleep_time: 0.01)
+    # we use ivars to avoid re-mocking the post method on subsequent calls
+    client.instance_variable_set("@_requests", [])
+
+    if !client.instance_variable_get("@_already_faked_post")
+      client.define_singleton_method(:post) do |*params|
+        @_requests.push(params)
+
+        FakeResponse.new(200, '')
+      end
+    end
+
+    client.instance_variable_set("@_already_faked_post", true)
+
+    yield
+
+    # let the flush thread run
+    wait_time = 0
+    while client.instance_variable_get("@_requests").empty?
+      wait_time += sleep_time
+      sleep sleep_time
+
+      raise "Waited #{max_wait} seconds for the flush thread to run, but it never did" if wait_time > max_wait
+    end
+
+    client.instance_variable_get("@_requests")
+  end
+
+  def assert_summary(client, data)
+    raise 'Evaluation summary aggregator not enabled' unless client.evaluation_summary_aggregator
+
+    assert_equal data, client.evaluation_summary_aggregator.data
+  end
+
+  def assert_example_contexts(client, data)
+    raise 'Example contexts aggregator not enabled' unless client.example_contexts_aggregator
+
+    assert_equal data, client.example_contexts_aggregator.data
+  end
+
+  def weighted_values(values_and_weights, hash_by_property_name: 'user.key')
+    values = values_and_weights.map do |value, weight|
+      weighted_value(value, weight)
+    end
+
+    PrefabProto::WeightedValues.new(weighted_values: values, hash_by_property_name: hash_by_property_name)
+  end
+
+  def weighted_value(string, weight)
+    PrefabProto::WeightedValue.new(
+      value: PrefabProto::ConfigValue.new(string: string), weight: weight
+    )
+  end
+
+  def context(properties)
+    Prefab::Context.new(properties)
+  end
+
+  def assert_only_expected_logs
+    assert_equal "WARN  2023-08-09 15:18:12 -0400: cloud.prefab.client No success loading checkpoints\n", $logs.string
+    # mark nil to indicate we handled it
+    $logs = nil
+  end
+
+  def assert_logged(expected)
+    # we do a uniq here because logging can happen in a separate thread so the
+    # number of times a log might happen could be slightly variable.
+    assert_equal expected, $logs.string.split("\n").uniq
+    # mark nil to indicate we handled it
+    $logs = nil
+  end
+
+  def assert_stderr(expected)
+    assert ($stderr.string.split("\n").uniq & expected).size > 0
+
+    # Ruby 2.X has a lot of warnings about instance variables not being
+    # initialized so we don't try to assert on stderr for those versions.
+    # Instead we just stop after asserting that our expected errors are
+    # included in the output.
+    if RUBY_VERSION.start_with?('2.')
+      puts $stderr.string
+      return
+    end
+
+    assert_equal expected, $stderr.string.split("\n")
+
+    # restore since we've handled it
+    $stderr = $oldstderr
+  end
+end

data/test/support/mock_base_client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class MockBaseClient
+  STAGING_ENV_ID = 1
+  PRODUCTION_ENV_ID = 2
+  TEST_ENV_ID = 3
+  attr_reader :namespace, :logger, :config_client, :options, :posts
+
+  def initialize(options = Prefab::Options.new)
+    @options = options
+    @namespace = namespace
+    @logger = Prefab::LoggerClient.new($stdout)
+    @config_client = MockConfigClient.new
+    @posts = []
+  end
+
+  def instance_hash
+    'mock-base-client-instance-hash'
+  end
+
+  def project_id
+    1
+  end
+
+  def post(_, _)
+    raise 'Use wait_for_post_requests'
+  end
+
+  def log
+    @logger
+  end
+
+  def log_internal(level, message); end
+
+  def context_shape_aggregator; end
+
+  def evaluation_summary_aggregator; end
+
+  def example_contexts_aggregator; end
+
+  def config_value(key)
+    @config_values[key]
+  end
+end

data/test/support/mock_config_client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class MockConfigClient
+  def initialize(config_values = {})
+    @config_values = config_values
+  end
+
+  def get(key, default = nil)
+    @config_values.fetch(key, default)
+  end
+
+  def get_config(key)
+    PrefabProto::Config.new(value: @config_values[key], key: key)
+  end
+
+  def mock_this_config(key, config_value)
+    @config_values[key] = config_value
+  end
+end

data/test/support/mock_config_loader.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true