steplib 0.9.0.9 → 0.9.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66bb253b9b4d908a32cc28ffb1f2b671d3c53848
-  data.tar.gz: 17f4d9fc6d09322e655d0e4d51ef3358981ca007
+  metadata.gz: 29beea916964360158c55afd643599b4c2cbacd1
+  data.tar.gz: 9b4b97d934c619c98f04b5625cf00076ac708892
 SHA512:
-  metadata.gz: 5e2534c38514f8509787b55cd493b8c5abbaf1e276826d97b25006ee7abb5c7672667d8999ee440ccbbe59168344b672534437d18a69bf10d16be7976bf61eab
-  data.tar.gz: 2a3c4bbba3dd0801a0fc0ffa5d7f7d9c9d25bbcd29c84dd466ed8bc5a8f74fd2e8930d8364462b8c70453248baec5cad6f64908fb03c41b336d0582b293256c8
+  metadata.gz: 664338f0de934c201ec60eac49e04200a609337945e9f63aad4d462b4b1dcdf4731da1cb85f3b31c8c83b19282043b95b59b2709259abdc71d472e74effd1f57
+  data.tar.gz: decd7a09acf49380bf5b52ef7958a17aed2cce998dc315ddf6aea250f297c06447bb32f9ce2494dd3675b840ed8b0c4fef045d7ad308021a92877845b8831e86

data/lib/steplib/steplib_updater.rb

@@ -16,6 +16,7 @@ module Steplib
 					{key: 'type_tags', value: []},
 					{key: 'inputs', value: []},
 					{key: 'outputs', value: []},
+					{key: 'log_highlights', value: []},
 					])
 				#
 				# inputs

data/lib/steplib/steplib_validator.rb

@@ -63,6 +63,12 @@ module Steplib
 						a_step_output,
 						required_step_version_outputs_properties_with_types().map { |e| e.first })
 				end
+				# log_highlights
+				step_version_data['log_highlights'] = step_version_data['log_highlights'].map do |a_step_log_highlight|
+					HashUtils.whitelist(
+						a_step_log_highlight,
+						required_step_version_log_highlights_properties_with_types().map { |e| e.first })
+				end
 				return step_version_data
 			end
 
@@ -85,11 +91,18 @@ module Steplib
 					['is_always_run', ABooleanValue],
 					['inputs', Array],
 					['outputs', Array],
+					['log_highlights', Array],
+					]
+			end
+
+			def optional_step_version_properties_with_types
+				return [
+					['icon_url_256', String],
 					]
 			end
 
 			def optional_step_version_properties
-				return ['icon_url_256']
+				return optional_step_version_properties_with_types().map { |e| e.first }
 			end
 
 			def required_step_version_source_properties_with_types
@@ -117,6 +130,13 @@ module Steplib
 					]
 			end
 
+			def required_step_version_log_highlights_properties_with_types
+				return [
+					['search_pattern', String],
+					['highlight_type', String]
+					]
+			end
+
 			def validate_step_version!(step_version_data)
 				# whitelist
 				step_version_data = whitelist_step_version(step_version_data)
@@ -126,10 +146,14 @@ module Steplib
 					required_step_version_properties_with_types()
 					)
 
-				# optional - can be nil
+				# optional
 				step_version_data = HashUtils.set_missing_defaults(
 					step_version_data,
-					[{key: 'icon_url_256', value: nil}])
+					[
+						{key: 'icon_url_256', value: nil},
+						{key: 'log_highlights', value: []}
+						]
+					)
 
 				HashUtils.check_required_attributes_and_types!(
 					step_version_data['source'],
@@ -171,6 +195,14 @@ module Steplib
 						required_step_version_outputs_properties_with_types()
 						)
 				end
+
+				a_log_highlights = step_version_data['log_highlights']
+				a_log_highlights.each do |a_log_highlight_itm|
+					HashUtils.check_required_attributes_and_types!(
+						a_log_highlight_itm,
+						required_step_version_log_highlights_properties_with_types()
+						)
+				end
 			end
 
 		end

data/lib/steplib/workflow_updater.rb

@@ -47,6 +47,7 @@ module Steplib
 					# main arrays
 					{key: 'inputs', value: []},
 					{key: 'outputs', value: []},
+					{key: 'log_highlights', value: []},
 					])
 				workflow_step_data['inputs'] = workflow_step_data['inputs'].map { |a_step_inp|
 					a_step_inp = HashUtils.set_missing_defaults(a_step_inp, [
@@ -175,4 +176,4 @@ module Steplib
 
 		end
 	end
-end
+end

data/lib/steplib/workflow_validator.rb

@@ -1,20 +1,69 @@
 require_relative 'hash_utils'
+require_relative 'steplib_validator'
 
 module Steplib
 	class WorkflowValidator
 		class << self
 
+			def whitelist_workflow(workflow_data)
+				whitelisted_data = HashUtils.whitelist(workflow_data,
+					only_attributes(allowed_top_level_attributes_with_types())
+					)
+
+				whitelisted_data['environments'] = whitelisted_data['environments'].map do |an_env|
+					whitelist_workflow_environment(an_env)
+				end
+
+				whitelisted_data['steps'] = whitelisted_data['steps'].map do |a_step_version|
+					whitelist_workflow_step_version(a_step_version)
+				end
+
+				return whitelisted_data
+			end
+
+			def whitelist_workflow_environment(workflow_env_data)
+				whitelisted_data = HashUtils.whitelist(workflow_env_data,
+					only_attributes(allowed_environment_attributes_with_types())
+					)
+				return whitelisted_data
+			end
+
+			def whitelist_workflow_step_version(workflow_step_version_data)
+				whitelisted_data = HashUtils.whitelist(workflow_step_version_data,
+					only_attributes(allowed_step_version_attributes_with_types())
+					)
+				whitelisted_data['inputs'] = whitelisted_data['inputs'].map do |a_step_input|
+					whitelist_workflow_step_version_input(a_step_input)
+				end
+				whitelisted_data['outputs'] = whitelisted_data['outputs'].map do |a_step_output|
+					whitelist_workflow_step_version_output(a_step_output)
+				end
+				return whitelisted_data
+			end
+
+			def whitelist_workflow_step_version_input(workflow_step_version_input_data)
+				whitelisted_data = HashUtils.whitelist(workflow_step_version_input_data,
+					only_attributes(allowed_step_version_input_attributes_with_types())
+					)
+				return whitelisted_data
+			end
+
+			def whitelist_workflow_step_version_output(workflow_step_version_output_data)
+				whitelisted_data = HashUtils.whitelist(workflow_step_version_output_data,
+					only_attributes(allowed_step_version_output_attributes_with_types())
+					)
+				return whitelisted_data
+			end
+
 			def validate_workflow!(workflow_data)
 				expected_format_version = '0.9.0'
 				if workflow_data['format_version'] != expected_format_version
 					raise "Invalid format_version, expected (#{expected_format_version}) got (#{workflow_data['format_version']})"
 				end
 
-				HashUtils.check_required_attributes_and_types!(workflow_data, [
-					['format_version', String],
-					['environments', Array],
-					['steps', Array]
-					])
+				HashUtils.check_required_attributes_and_types!(workflow_data,
+					required_top_level_attributes_with_types()
+					)
 
 				envs_arr = workflow_data['environments']
 				envs_arr.each do |a_env_data|
@@ -28,35 +77,13 @@ module Steplib
 			end
 
 			def validate_workflow_environment!(env_item_data)
-				HashUtils.check_required_attributes_and_types!(env_item_data, [
-					['title', String],
-					['mapped_to', String],
-					['is_expand', ABooleanValue],
-					['value', String],
-					])
+				HashUtils.check_required_attributes_and_types!(env_item_data,
+					required_environment_attributes_with_types())
 			end
 
 			def validate_workflow_step!(workflow_step_data)
-				HashUtils.check_required_attributes_and_types!(workflow_step_data, [
-					['position_in_workflow', Fixnum],
-					['is_always_run', ABooleanValue],
-					# auto generated
-					['id', String],
-					['steplib_source', String],
-					['version_tag', String],
-					# data from step.yml
-					['name', String],
-					['description', String],
-					['website', String],
-					['fork_url', String],
-					['source', Hash],
-					['host_os_tags', Array],
-					['project_type_tags', Array],
-					['type_tags', Array],
-					['is_requires_admin_user', ABooleanValue],
-					['inputs', Array],
-					['outputs', Array],
-					])
+				HashUtils.check_required_attributes_and_types!(workflow_step_data,
+					required_step_version_attributes_with_types())
 
 				# optional - can be nil
 				workflow_step_data = HashUtils.set_missing_defaults(
@@ -84,16 +111,9 @@ module Steplib
 
 				a_inputs = workflow_step_data['inputs']
 				a_inputs.each do |a_input_itm|
-					HashUtils.check_required_attributes_and_types!(a_input_itm, [
-					['title', String],
-					['description', String],
-					['mapped_to', String],
-					['is_expand', ABooleanValue],
-					['is_required', ABooleanValue],
-					['value_options', Array],
-					['value', String],
-					['is_dont_change_value', ABooleanValue]
-					])
+					HashUtils.check_required_attributes_and_types!(a_input_itm,
+						required_step_version_input_attributes()
+						)
 
 					a_value_options = a_input_itm['value_options']
 					a_value_options.each { |a_value_option|
@@ -103,14 +123,75 @@ module Steplib
 
 				a_outputs = workflow_step_data['outputs']
 				a_outputs.each do |a_output_itm|
-					HashUtils.check_required_attributes_and_types!(a_output_itm, [
-					['title', String],
-					['description', String],
-					['mapped_to', String]
-					])
+					HashUtils.check_required_attributes_and_types!(a_output_itm,
+						required_step_version_output_attributes())
 				end
 			end
 
+
+			#
+			# required and allowed properties
+
+			def required_top_level_attributes_with_types
+				return [
+					['format_version', String],
+					['environments', Array],
+					['steps', Array]
+					]
+			end
+
+			def allowed_top_level_attributes_with_types
+				return required_top_level_attributes_with_types().concat([
+					['meta', Hash]
+					])
+			end
+
+			def required_environment_attributes_with_types
+				return [
+					['title', String],
+					['mapped_to', String],
+					['is_expand', ABooleanValue],
+					['value', String],
+					]
+			end
+
+			def allowed_environment_attributes_with_types
+				return required_environment_attributes_with_types()
+			end
+
+			def required_step_version_attributes_with_types
+				return [
+					['position_in_workflow', Fixnum],
+					['is_always_run', ABooleanValue],
+				].concat Steplib::SteplibValidator.required_step_version_properties_with_types()
+			end
+
+			def allowed_step_version_attributes_with_types
+				return required_step_version_attributes_with_types().concat(
+					Steplib::SteplibValidator.optional_step_version_properties_with_types()
+				)
+			end
+
+			def required_step_version_input_attributes
+				return Steplib::SteplibValidator.required_step_version_inputs_properties_with_types()
+			end
+
+			def required_step_version_output_attributes
+				return Steplib::SteplibValidator.required_step_version_outputs_properties_with_types()
+			end
+
+			def allowed_step_version_input_attributes_with_types
+				return Steplib::SteplibValidator.required_step_version_inputs_properties_with_types()
+			end
+
+			def allowed_step_version_output_attributes_with_types
+				return Steplib::SteplibValidator.required_step_version_outputs_properties_with_types()
+			end
+
+			def only_attributes(attributes_list_with_types)
+				return attributes_list_with_types.map { |e| e.first }
+			end
+
 		end
 	end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steplib
 version: !ruby/object:Gem::Version
-  version: 0.9.0.9
+  version: 0.9.0.10
 platform: ruby
 authors:
 - Bitrise
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: StepLib.com's validator and other utilities GEM