chore: features: isolate 'select' and 'configure' to 'Menus' class (be258682) · Commits · RadianDevCore / Tools / gcil

gitlabci_local/cli/main.py

+9 −9

Changes for gitlabci_local/cli/main.py: 9 added lines, 9 removed lines.
Original line number	Diff line number	Diff line
		@@ -8,8 +8,8 @@ from subprocess import check_output, DEVNULL, Popen
		from sys import argv, exit

		# Components
		from ..menu import selector
		from ..engines.engine import supported as engine_supported
		from ..features.menus import MenusFeature
		from ..features.images import ImagesFeature
		from ..features.jobs import JobsFeature
		from ..features.pipelines import PipelinesFeature
		@@ -222,37 +222,37 @@ def main():

		# Pull jobs images
		elif options.pull:
		result = ImagesFeature(jobs, options).pull(force=options.force)
		result = ImagesFeature(jobs=jobs, options=options).pull(force=options.force)

		# Remove jobs images
		elif options.rmi:
		result = ImagesFeature(jobs, options).rmi()
		result = ImagesFeature(jobs=jobs, options=options).rmi()

		# Select job
		elif options.list and interactive:
		options.manual = True
		result = selector(options, jobs)
		result = MenusFeature(jobs=jobs, options=options).select()

		# Select jobs
		elif options.select and interactive:
		result = selector(options, jobs)
		result = MenusFeature(jobs=jobs, options=options).select()

		# Launch pipeline
		elif options.pipeline:
		result = PipelinesFeature(jobs, options).launch()
		result = PipelinesFeature(jobs=jobs, options=options).launch()

		# Launch jobs
		elif options.names:
		result = PipelinesFeature(jobs, options).launch()
		result = PipelinesFeature(jobs=jobs, options=options).launch()

		# Select jobs
		elif interactive:
		result = selector(options, jobs)
		result = MenusFeature(jobs=jobs, options=options).select()

		# Launch all jobs
		elif options.all:
		options.pipeline = True
		result = PipelinesFeature(jobs, options).launch()
		result = PipelinesFeature(jobs=jobs, options=options).launch()

		# Unsupported case
		else:

gitlabci_local/features/menus.py

0 → 100644

+327 −0

Changes for gitlabci_local/features/menus.py: 327 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		#!/usr/bin/env python3

		# Standard libraries
		from json import load as json_load
		from os import environ
		from pathlib import Path

		# Modules libraries
		from oyaml import safe_load as yaml_safe_load
		from PyInquirer import prompt as PyInquirer_prompt
		from PyInquirer import Separator as PyInquirer_Separator

		# Components
		from ..package.bundle import Bundle
		from ..package.patcher import Patcher
		from ..prints.colors import Colors
		from ..prints.menus import Menus
		from ..system.platform import Platform
		from ..types.dicts import Dicts
		from ..types.lists import Lists
		from .pipelines import PipelinesFeature

		# MenusFeature class
		class MenusFeature:

		# Members
		__jobs = None
		__options = None

		# Constructor
		def __init__(self, jobs=None, options=None):

		# Prepare jobs
		self.__jobs = jobs

		# Prepare options
		self.__options = options

		# Patch theme
		Patcher()

		# Select
		def select(self):

		# Variables
		default_check = self.__options.all
		jobs_available = False
		jobs_choices = []
		result = True
		stage = ''

		# Stages groups
		for job in self.__jobs:

		# Filter names
		if self.__options.names:

		# Filter jobs list
		if not self.__options.pipeline and not Lists.match(
		self.__options.names, job, ignore_case=self.__options.ignore_case,
		no_regex=self.__options.no_regex):
		continue

		# Filter stages list
		if self.__options.pipeline and not Lists.match(
		self.__options.names, self.__jobs[job]['stage'],
		ignore_case=self.__options.ignore_case,
		no_regex=self.__options.no_regex):
		continue

		# Stages separator
		if stage != self.__jobs[job]['stage']:
		stage = self.__jobs[job]['stage']
		jobs_choices += [PyInquirer_Separator('\n Stage %s:' % (stage))]

		# Initial job details
		job_details = ''
		job_details_list = []

		# Disabled jobs
		disabled = False
		if self.__jobs[job]['when'] in ['manual'] and not self.__options.manual:
		disabled = 'Manual'
		else:
		if self.__jobs[job]['when'] == 'manual':
		job_details_list += ['Manual']
		elif self.__jobs[job]['when'] == 'on_failure':
		job_details_list += ['On failure']
		jobs_available = True

		# Parser disabled jobs
		if self.__jobs[job]['options']['disabled']:
		disabled = self.__jobs[job]['options']['disabled']

		# Failure allowed jobs
		if self.__jobs[job]['allow_failure']:
		job_details_list += ['Failure allowed']

		# Register job tags
		tags = ''
		if self.__jobs[job]['tags']:
		tags = ' [%s]' % (','.join(self.__jobs[job]['tags']))

		# Prepare job details
		if job_details_list:
		job_details = ' (' + ', '.join(job_details_list) + ')'

		# Job choices
		jobs_choices += [{
		'name': '%s%s%s' % (self.__jobs[job]['name'], tags, job_details),
		'value': job,
		'checked': default_check,
		'disabled': disabled
		}]

		# Prepare jobs selection
		selection_type = 'list' if self.__options.list else 'checkbox'
		selection_prompt = [{
		'type': selection_type,
		'qmark': '',
		'message': '===[ Jobs selector ]===',
		'name': 'jobs',
		'choices': jobs_choices
		}]

		# Request jobs selection
		if jobs_choices and jobs_available:
		answers = PyInquirer_prompt(selection_prompt, style=Menus.Themes.SELECTOR)
		else:
		print(' %s%s: %sERROR: %sNo jobs found for selection%s' %
		(Colors.GREEN, Bundle.NAME, Colors.RED, Colors.BOLD, Colors.RESET))
		answers = None

		# Parse jobs selection
		if answers and 'jobs' in answers:
		if self.__options.list:
		self.__options.names = [answers['jobs']]
		else:
		self.__options.names = answers['jobs']
		else:
		self.__options.names = []

		# Drop pipeline mode for jobs
		self.__options.pipeline = False

		# Footer
		print(' ')
		print(' ')
		Platform.flush()

		# Launch jobs
		if self.__options.names:
		result = PipelinesFeature(self.__jobs, self.__options).launch()

		# Result
		return result

		# Configure
		def configure(self, configurations):

		# Variables
		result = dict()

		# Header
		print(' ')
		print(' %s===[ %sConfigurations menu %s]===%s' %
		(Colors.GREEN, Colors.YELLOW, Colors.GREEN, Colors.RESET))
		print(' ')
		Platform.flush()

		# Walk through configurations
		for variable in configurations:

		# Variables
		variable_choices = []
		variable_default = ''
		variable_index = 0
		variable_set = False
		variable_values = []

		# Extract configuration fields
		variable_node = configurations[variable]
		variable_help = variable_node['help']
		variable_type = variable_node['type']

		# Prepare configuration selection
		configuration_prompt = [{
		'name': variable,
		'qmark': '',
		'message': 'Variable %s: %s:' % (variable, variable_help),
		}]

		# Extract environment variable
		if variable in environ:
		variable_default = environ[variable]
		variable_set = True

		# Parse configuration types: boolean
		if variable_type == 'boolean':
		if 'default' in variable_node and variable_node['default'] in [
		False, 'false'
		]:
		variable_values = ['false', 'true']
		else:
		variable_values = ['true', 'false']
		if not variable_set:
		variable_default = variable_values[0]
		for choice in variable_values:
		variable_index += 1
		variable_choices += [{
		# 'key': str(variable_index),
		'name': '%s' % (choice),
		'value': choice
		}]
		configuration_prompt[0]['type'] = 'list'
		configuration_prompt[0]['choices'] = variable_choices

		# Parse configuration types: choice
		elif variable_type == 'choice':
		variable_values = variable_node['values']
		if not variable_set:
		variable_default = variable_values[0]
		for choice in variable_values:
		variable_index += 1
		variable_choices += [{
		'key': str(variable_index),
		'name': '%s' % (choice),
		'value': choice
		}]
		configuration_prompt[0]['type'] = 'list'
		configuration_prompt[0]['choices'] = variable_choices

		# Parse configuration types: input
		elif variable_type == 'input':
		configuration_prompt[0]['type'] = 'input'
		if 'default' in variable_node and variable_node[
		'default'] and not variable_set:
		variable_default = variable_node['default']
		configuration_prompt[0]['default'] = variable_default

		# Parse configuration types: json
		elif variable_type == 'json':
		if not variable_set:
		configuration_path = Path(self.__options.path) / variable_node['path']
		configuration_key = variable_node['key']
		with open(configuration_path, 'r') as configuration_data:
		configuration_dict = json_load(configuration_data)
		variable_values = Dicts.find(configuration_dict,
		configuration_key)
		if not variable_values:
		raise ValueError(
		'Unknown "%s" key in %s for "%s"' %
		(configuration_key, configuration_path, variable))
		if isinstance(variable_values, str):
		variable_values = [variable_values]
		for choice in variable_values:
		variable_index += 1
		variable_choices += [{
		'key': str(variable_index),
		'name': '%s' % (choice),
		'value': choice
		}]
		configuration_prompt[0]['type'] = 'list'
		configuration_prompt[0]['choices'] = variable_values
		variable_default = variable_values[0]

		# Parse configuration types: yaml
		elif variable_type == 'yaml':
		if not variable_set:
		configuration_path = Path(self.__options.path) / variable_node['path']
		configuration_key = variable_node['key']
		with open(configuration_path, 'r') as configuration_data:
		configuration_dict = yaml_safe_load(configuration_data)
		variable_values = Dicts.find(configuration_dict,
		configuration_key)
		if not variable_values:
		raise ValueError(
		'Unknown "%s" key in %s for "%s"' %
		(configuration_key, configuration_path, variable))
		if isinstance(variable_values, str):
		variable_values = [variable_values]
		for choice in variable_values:
		variable_index += 1
		variable_choices += [{
		'key': str(variable_index),
		'name': '%s' % (choice),
		'value': choice
		}]
		configuration_prompt[0]['type'] = 'list'
		configuration_prompt[0]['choices'] = variable_values
		variable_default = variable_values[0]

		# Parse configuration types: unknown
		else:
		print(' ')
		print(' %s%s: %sERROR: %sUnsupported configuration type "%s"...%s' %
		(Colors.GREEN, Bundle.NAME, Colors.RED, Colors.BOLD, variable_type,
		Colors.RESET))
		print(' ')
		Platform.flush()
		raise NotImplementedError(
		'Unsupported configuration type "%s"' % (variable_type))

		# Extract environment variable
		if variable in environ:
		variable_default = environ[variable]
		variable_set = True

		# Request configuration selection
		if not Platform.IS_TTY_STDIN or variable_set or self.__options.defaults:
		result[variable] = str(variable_default)
		print(
		' %s%s %s%s%s' % (Colors.YELLOW, configuration_prompt[0]['message'],
		Colors.CYAN, result[variable], Colors.RESET))
		else:
		answers = PyInquirer_prompt(configuration_prompt,
		style=Menus.Themes.CONFIGURATIONS)
		if not answers:
		raise KeyboardInterrupt
		result[variable] = str(answers[variable])

		# Footer
		print(' ')
		Platform.flush()

		# Result
		return result

gitlabci_local/menu.py

deleted100755 → 0

+0 −307

File deleted.

Preview size limit exceeded, changes collapsed.

gitlabci_local/parsers/gitlab.py

+2 −2

Changes for gitlabci_local/parsers/gitlab.py: 2 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -12,7 +12,7 @@ from oyaml import safe_load as yaml_safe_load

		# Components
		from ..containers.images import Images
		from ..menu import configurator
		from ..features.menus import MenusFeature

		# GitLab class
		class GitLab:
		@@ -203,7 +203,7 @@ class GitLab:

		# Parse local configurations
		if 'configurations' in local:
		configured_variables = configurator(self.__options,
		configured_variables = MenusFeature(options=self.__options).configure(
		local['configurations'])
		global_values['variables'].update(configured_variables)