gooddata 1.0.0-java

data/spec/unit/helpers_spec.rb

@@ -0,0 +1,254 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'gooddata/client'
+require 'gooddata/models/model'
+
+describe GoodData::Helpers do
+  describe '#home_directory' do
+    it 'works' do
+      GoodData::Helpers.home_directory
+    end
+  end
+
+  describe '#running_on_windows?' do
+    it 'works' do
+      result = GoodData::Helpers.running_on_windows?
+      # rubocop:disable Style/DoubleNegation
+      !!result.should == result
+      # rubocop:enable Style/DoubleNegation
+    end
+  end
+
+  describe '#running_on_mac?' do
+    it 'works' do
+      result = GoodData::Helpers.running_on_a_mac?
+      # rubocop:disable Style/DoubleNegation
+      !!result.should == result
+      # rubocop:enable Style/DoubleNegation
+    end
+  end
+
+  describe '#error' do
+    it 'works' do
+      expect { GoodData::Helpers.error('Test Error') }.to raise_error(SystemExit)
+    end
+  end
+
+  describe "#decode_params" do
+    it 'decodes the data params from json' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'gd_encoded_params' => '{"deep": {"deeper": "deep value"}}'
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'deep' => {
+          'deeper' => 'deep value'
+        }
+      }
+      result = GoodData::Helpers.decode_params(params)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'should not show reference parameter values when get error' do
+      params = {
+        'secret' => 'you will not see it',
+        'gd_encoded_params' => "{\"abc\": \"${secret}\",}"
+      }
+      expect { GoodData::Helpers.decode_params(params, resolve_reference_params: true) }.to raise_error do |e|
+        expect(e.message).not_to include('you will not see it')
+      end
+    end
+
+    it 'ignore value of encoded params if its value is not collection or String when resolve reference params' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'gd_encoded_params' => { "deep" => { "deeper" => "deep value" }, "bool" => true, "int" => 1 }
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'deep' => {
+          'deeper' => 'deep value'
+        },
+        "bool" => true,
+        "int" => 1
+      }
+      result = GoodData::Helpers.decode_params(params, resolve_reference_params: true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes the hidden_data in hidden params' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'gd_encoded_hidden_params' => '{"deep_secret": {"deeper_secret": "hidden value"}}'
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        "gd_encoded_hidden_params" => nil,
+        "deep_secret" => {
+          "deeper_secret" => "hidden value"
+        }
+      }
+      result = GoodData::Helpers.decode_params(params)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes the reference parameters in gd_encoded_params in String form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => '{"login_username": "login_user", "login_password": "${my_password}", "data01": "\\\\${my_password}", "data02":"abc\\\\def"}'
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'login_password' => 'login_123',
+        'data01' => '\\login_123',
+        'data02' => 'abc\\def'
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes the reference parameters in gd_encoded_params in Hash form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => { "login_username" => "login_user", "login_password" => "${my_password}", "data01" => "\\\\${my_password}", "data02" => "abc\\def" }
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'login_password' => 'login_123',
+        'data01' => '\\login_123',
+        'data02' => 'abc\\def'
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes escape the reference parameters in gd_encoded_params in String form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => '{"login_username": "login_user", "data01": "\\${abc}"}'
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'data01' => '${abc}'
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes escape the reference parameters in gd_encoded_params in Hash form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => { "login_username" => "login_user", "data01" => "\\${abc}" }
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'data01' => '${abc}'
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes the reference parameters in nested block in gd_encoded_params in String form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => '{"login_username": "login_user", "login_password": "${my_password}", "ads_client": {"username": "ads_user", "password": "${ads_password}"}}'
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'login_password' => 'login_123',
+        'ads_client' => {
+          'username' => 'ads_user',
+          'password' => 'ads_123'
+        }
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'decodes the reference parameters in nested block in gd_encoded_params in Hash form' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'gd_encoded_params' => {
+          "login_username" => "login_user",
+          "login_password" => "${my_password}",
+          "ads_client" => {
+            "username" => "ads_user",
+            "password" => "${ads_password}"
+          }
+        }
+      }
+      expected_result = {
+        'param' => 'value',
+        'number_param' => 5,
+        'ads_password' => 'ads_123',
+        'my_password' => 'login_123',
+        'login_username' => 'login_user',
+        'login_password' => 'login_123',
+        'ads_client' => {
+          'username' => 'ads_user',
+          'password' => 'ads_123'
+        }
+      }
+      result = GoodData::Helpers.decode_params(params, :resolve_reference_params => true)
+      expect(result).to eq(expected_result)
+    end
+
+    it 'throws an error when data params is not a valid json' do
+      params = {
+        'param' => 'value',
+        'number_param' => 5,
+        'gd_encoded_params' => 'This is no json.'
+      }
+      expect { GoodData::Helpers.decode_params(params) }.to raise_error(JSON::ParserError)
+    end
+  end
+end

data/spec/unit/lcm/user_bricks_helper_spec.rb

@@ -0,0 +1,58 @@
+describe GoodData::LCM2::UserBricksHelper do
+  subject { GoodData::LCM2::UserBricksHelper.resolve_client_id(domain, project, data_product) }
+  let(:domain) { double('domain') }
+  let(:project) { double('project') }
+  let(:data_product) { double('data_product') }
+  let(:project_uri) { '/gdc/projects/fooooo' }
+  let(:clients) { [client] }
+  let(:client) { double('client') }
+  let(:client_id) { 'bar' }
+  let(:project_id) { 'baz' }
+
+  before do
+    allow(project).to receive(:metadata).and_return(metadata)
+    allow(project).to receive(:uri).and_return(project_uri)
+    allow(domain).to receive(:clients).and_return(clients)
+    allow(client).to receive(:project_uri).and_return(project_uri)
+    allow(client).to receive(:id).and_return(client_id)
+    allow(project).to receive(:id).and_return(project_id)
+    allow(project).to receive(:pid).and_return(project_id)
+  end
+  shared_examples_for 'a client id resolver' do
+    context 'when client matches specified project url' do
+      it 'returns client id' do
+        expect(subject).to eq(client_id)
+      end
+    end
+  end
+
+  describe '.resolve_client_id' do
+    context 'when GOODOT_CUSTOM_PROJECT_ID specified' do
+      let(:metadata) { { 'GOODOT_CUSTOM_PROJECT_ID' => client_id } }
+      it_behaves_like 'a client id resolver'
+
+      context 'when goodot id does not match client id' do
+        before { allow(client).to receive(:id).and_return('different_id') }
+        it 'raises an error' do
+          expect { subject }.to raise_error(/doesn't match client id/)
+        end
+      end
+    end
+
+    context 'when GOODOT_CUSTOM_PROJECT_ID not specified' do
+      let(:metadata) { { 'GOODOT_CUSTOM_PROJECT_ID' => nil } }
+      it_behaves_like 'a client id resolver'
+
+      context 'when no client matches project url' do
+        before do
+          allow(client).to receive(:project_uri).and_return('different/uri')
+        end
+
+        it 'raises an error' do
+          expected = /does not contain key GOODOT_CUSTOM_PROJECT_ID/
+          expect { subject }.to raise_error(expected)
+        end
+      end
+    end
+  end
+end

data/spec/unit/models/blueprint/attribute_sort_by_spec.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'gooddata'
+
+describe GoodData::Model::AttributeBlueprintField do
+  before(:each) do
+    @model_view = MultiJson.load(File.read('./spec/data/wire_models/attribute_sort_by_model.json'))
+    @blueprint = GoodData::Model::FromWire.from_wire(@model_view)
+    @dataset = @blueprint.datasets('dataset.id')
+    @attribute = @dataset.attributes('attr.id.name')
+  end
+
+  it 'should return label id and direction of sorted attribute' do
+    expect(@attribute.order_by).to eq 'label.id.name.name_label_2 - DESC'
+  end
+end

data/spec/unit/models/blueprint/attributes_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'gooddata'
+
+describe GoodData::Model::AttributeBlueprintField do
+  before(:each) do
+    @model_view = MultiJson.load(File.read('./spec/data/wire_models/model_view.json'))
+    @blueprint = GoodData::Model::FromWire.from_wire(@model_view)
+    @dataset = @blueprint.datasets('dataset.account')
+    @attribute = @dataset.attributes('attr.account.region')
+  end
+
+  describe '#labels' do
+    it 'should return labels on dataset' do
+      expect(@attribute.labels.count).to eq 1
+    end
+  end
+
+  describe '#dataset' do
+    it 'should return dataset of the attribtue field' do
+      expect(@attribute.dataset_blueprint).to eq @dataset
+    end
+  end
+end

data/spec/unit/models/blueprint/dataset_spec.rb

@@ -0,0 +1,120 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2010-2017 GoodData Corporation. All rights reserved.
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'gooddata'
+
+describe GoodData::Model::DatasetBlueprint do
+  before(:each) do
+    @model_view = MultiJson.load(File.read('./spec/data/wire_models/model_view.json'))
+    @blueprint = GoodData::Model::FromWire.from_wire(@model_view)
+    @dataset = @blueprint.datasets('dataset.opportunityanalysis')
+    @small_blueprint = GoodData::Model::ProjectBlueprint.build('my_bp') do |p|
+      p.add_dataset('dataset.countries') do |d|
+        d.add_anchor('attr.country')
+        d.add_label('label.country.name', reference: 'attr.country')
+      end
+      p.add_dataset('dataset.repos') do |d|
+        d.add_anchor('attr.repository')
+        d.add_label('label.repo.name', reference: 'attr.repository')
+        d.add_reference('dataset.countries')
+      end
+      p.add_dataset('dataset.devs') do |d|
+        d.add_anchor('attr.dev')
+        d.add_label('label.dev.name', reference: 'attr.dev')
+      end
+      p.add_dataset('dataset.commits') do |d|
+        d.add_anchor('attr.commits')
+        d.add_attribute('attr.quality')
+        d.add_label('label.quality', reference: 'attr.quality')
+        d.add_fact('more_numbers')
+        d.add_reference('dataset.repos')
+        d.add_reference('dataset.devs')
+      end
+    end
+  end
+
+  describe '#facts' do
+    it 'should return facts on dataset' do
+      expect(@dataset.facts.count).to eq 2
+      expect(@dataset.facts.map(&:id).to_set).to eq [
+        'fact.opportunityanalysis.buckets_to_display',
+        'fact.opportunityanalysis.month_fact'
+      ].to_set
+    end
+
+    it 'should be able to pick specific fact' do
+      expect(@dataset.facts('fact.opportunityanalysis.buckets_to_display').id).to eq 'fact.opportunityanalysis.buckets_to_display'
+    end
+  end
+
+  describe '#attributes' do
+    it 'should return attributes on dataset' do
+      expect(@dataset.attributes.count).to eq 2
+      expect(@dataset.attributes.map(&:id).to_set).to eq [
+        'attr.opportunityanalysis.month',
+        'attr.opportunityanalysis.cohorttype'
+      ].to_set
+    end
+
+    it 'should return attributes on dataset' do
+      expect(@dataset.attributes('attr.opportunityanalysis.cohorttype').id).to eq 'attr.opportunityanalysis.cohorttype'
+    end
+  end
+
+  describe '#labels' do
+    it 'should return labels on dataset' do
+      expect(@dataset.labels.count).to eq 4
+      expect(@dataset.labels.map(&:id).to_set).to eq [
+        'label.opportunityanalysis.month.monthsortingnew',
+        'label.opportunityanalysis.month',
+        'label.opportunityanalysis.cohorttype',
+        'label.opportunityanalysis.techoppanalysis'
+      ].to_set
+    end
+  end
+
+  describe '#references' do
+    it 'should return references on dataset' do
+      expect(@dataset.references.count).to eq 2
+      expect(@dataset.references.map { |r| r.data[:dataset] }).to eq [
+        'dataset.opp_records',
+        'dataset.consolidatedmarketingstatus'
+      ]
+    end
+  end
+
+  describe '#referenced_by' do
+    it 'should return datasets that are referencing this one' do
+      expect(@dataset.referenced_by).to eq []
+      dimension = @blueprint.datasets('dataset.opp_records')
+      expect(dimension.referenced_by.map(&:id)).to eq ['dataset.opportunityanalysis']
+    end
+  end
+
+  describe '#referencing' do
+    it 'should return datasets that are referenced by this one (the references in the dataset leads to those datasets)' do
+      expect(@dataset.referencing.map(&:id)).to eq ['dataset.opp_records', 'dataset.consolidatedmarketingstatus']
+      dimension = @blueprint.datasets('dataset.productline')
+      expect(dimension.referencing.map(&:id)).to be_empty
+      dimension = @blueprint.datasets('dataset.opp_records')
+      expect(dimension.referencing.map(&:id).count).to eq 28
+    end
+  end
+
+  describe '#breaks' do
+    it 'should return attributes that the dataset can break' do
+      expect(@small_blueprint.datasets('dataset.countries').breaks.map(&:id)).to eq ['attr.country', 'attr.repository', 'attr.quality']
+      expect(@small_blueprint.datasets('dataset.devs').breaks.map(&:id)).to eq ['attr.dev', 'attr.quality']
+    end
+  end
+
+  describe '#broken_by' do
+    it 'should return attributes that the dataset can be broken by' do
+      expect(@small_blueprint.datasets('dataset.commits').broken_by.map(&:id)).to eq ['attr.quality', 'attr.repository', 'attr.country', 'attr.dev']
+      expect(@small_blueprint.datasets('dataset.devs').broken_by.map(&:id)).to eq ['attr.dev']
+    end
+  end
+end