secator 0.1.0__tar.gz → 0.2.0__tar.gz

secator-0.2.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [0.2.0](https://github.com/freelabz/secator/compare/v0.1.1...v0.2.0) (2024-04-08)
+
+
+### Features
+
+* add build & release CLI commands ([#247](https://github.com/freelabz/secator/issues/247)) ([775eba1](https://github.com/freelabz/secator/commit/775eba16d3a6f9d8cbc83f81daed85fb806fe6db))
+
+
+### Bug Fixes
+
+* docker build & push ([#250](https://github.com/freelabz/secator/issues/250)) ([7cebd9f](https://github.com/freelabz/secator/commit/7cebd9fe61f6dbb76e9f78fcbcd3514d68204c87))
+* install issues & docs ([#243](https://github.com/freelabz/secator/issues/243)) ([0447148](https://github.com/freelabz/secator/commit/0447148c89f13884cbc14579d953e0d3e067cbe2)), closes [#242](https://github.com/freelabz/secator/issues/242) [#241](https://github.com/freelabz/secator/issues/241) [#240](https://github.com/freelabz/secator/issues/240) [#239](https://github.com/freelabz/secator/issues/239)

{secator-0.1.0 → secator-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: secator
-Version: 0.1.0
+Version: 0.2.0
 Summary: The pentester's swiss knife.
 Project-URL: Homepage, https://github.com/freelabz/secator
 Project-URL: Issues, https://github.com/freelabz/secator/issues
@@ -34,6 +34,8 @@ Requires-Dist: rich-click<1.7
 Requires-Dist: rich<14
 Requires-Dist: validators<1
 Requires-Dist: xmltodict<1
+Provides-Extra: build
+Requires-Dist: hatch<2; extra == 'build'
 Provides-Extra: dev
 Requires-Dist: asciinema-automation<1; extra == 'dev'
 Requires-Dist: coverage<8; extra == 'dev'
@@ -319,6 +321,26 @@ secator install addons trace
 
 </details>
 
+<details>
+	<summary>build</summary>
+
+Add `hatch` for building and publishing the PyPI package.
+
+```sh
+secator install addons build
+```
+
+</details>
+
+
+### Install CVEs
+
+`secator` makes remote API calls to https://cve.circl.lu/ to get in-depth information about the CVEs it encounters.
+We provide a subcommand to download all known CVEs locally so that future lookups are made from disk instead:
+```sh
+secator install cves
+```
+
 ### Checking installation health
 
 To figure out which languages or tools are installed on your system (along with their version):

{secator-0.1.0 → secator-0.2.0}/README.md

@@ -262,6 +262,26 @@ secator install addons trace
 
 </details>
 
+<details>
+	<summary>build</summary>
+
+Add `hatch` for building and publishing the PyPI package.
+
+```sh
+secator install addons build
+```
+
+</details>
+
+
+### Install CVEs
+
+`secator` makes remote API calls to https://cve.circl.lu/ to get in-depth information about the CVEs it encounters.
+We provide a subcommand to download all known CVEs locally so that future lookups are made from disk instead:
+```sh
+secator install cves
+```
+
 ### Checking installation health
 
 To figure out which languages or tools are installed on your system (along with their version):

{secator-0.1.0 → secator-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "secator"
-version = "0.1.0"
+version = "0.2.0"
 authors = [{ name = "FreeLabz", email = "sales@freelabz.com" }]
 readme = "README.md"
 description = "The pentester's swiss knife."
@@ -55,6 +55,9 @@ dev = [
   'watchdog < 3',
   'asciinema-automation < 1',
 ]
+build = [
+  'hatch < 2',
+]
 trace = [
   'memray < 2',
   'pyinstrument < 5',

secator-0.2.0/scripts/install.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+YELLOW='\033[0;93m'
+GREEN='\033[0;92m'
+NC='\033[0m' # No Color
+
+echo -e "🗄 ${YELLOW}Running apt update ...${NC}"
+sudo apt update
+echo -e "🗄 ${GREEN}Ran apt update successfully !${NC}\n"
+
+echo -e "🗄 ${YELLOW}Installing Python and pipx ...${NC}"
+sudo apt install -y python3-pip pipx
+echo -e "🗄 ${GREEN}pipx installed successfully !${NC}\n"
+
+echo -e "🗄 ${YELLOW}Setting \$PATH ...${NC}"
+export PATH=$PATH:~/.local/bin:~/go/bin
+echo -e "🗄 ${GREEN}\$PATH modified successfully !${NC}\n"
+
+echo -e "🗄 ${YELLOW}Installing secator and dependencies ...${NC}"
+pipx install secator
+secator install langs go
+secator install langs ruby
+secator install tools
+secator install addons redis
+secator install addons worker
+secator install addons google
+secator install addons mongodb
+echo -e "🗄 ${GREEN}secator installed successfully !${NC}\n"
+
+echo -e "🗄 ${YELLOW}Adding ~/go/bin and ~/.local/bin to \$PATH in .bashrc ...${NC}"
+echo "export PATH=$PATH:~/go/bin:~/.local/bin" >> ~/.bashrc
+source ~/.bashrc
+echo -e "🗄 ${GREEN}\$PATH modified successfully !${NC}\n"

{secator-0.1.0 → secator-0.2.0}/secator/cli.py

@@ -12,10 +12,12 @@ from rich.rule import Rule
 
 from secator.config import ConfigLoader
 from secator.decorators import OrderedGroup, register_runner
-from secator.definitions import (ASCII, CVES_FOLDER, DATA_FOLDER,
+from secator.definitions import (ASCII, CVES_FOLDER, DATA_FOLDER,  # noqa: F401
+								 BUILD_ADDON_ENABLED, DEV_ADDON_ENABLED, DEV_PACKAGE,
+								 GOOGLE_ADDON_ENABLED, LIB_FOLDER, MONGODB_ADDON_ENABLED,
 								 OPT_NOT_SUPPORTED, PAYLOADS_FOLDER,
-								 ROOT_FOLDER, SCRIPTS_FOLDER, VERSION,
-								 WORKER_ADDON_ENABLED, DEV_ADDON_ENABLED, DEV_PACKAGE)
+								 REDIS_ADDON_ENABLED, REVSHELLS_FOLDER, ROOT_FOLDER,
+								 TRACE_ADDON_ENABLED, VERSION, WORKER_ADDON_ENABLED)
 from secator.rich import console
 from secator.runners import Command
 from secator.serializers.dataclass import loads_dataclass
@@ -28,10 +30,6 @@ ALL_TASKS = discover_tasks()
 ALL_CONFIGS = ConfigLoader.load_all()
 ALL_WORKFLOWS = ALL_CONFIGS.workflow
 ALL_SCANS = ALL_CONFIGS.scan
-DEFAULT_CMD_OPTS = {
-	'no_capture': True,
-	'print_cmd': True,
-}
 
 
 #-----#
@@ -48,7 +46,11 @@ def cli(ctx, no_banner, version):
 		print(ASCII, file=sys.stderr)
 	if ctx.invoked_subcommand is None:
 		if version:
-			print(f'Current Version: v{VERSION}')
+			console.print(f'[bold gold3]Current version[/]: v{VERSION}', highlight=False)
+			console.print(f'[bold gold3]Python binary[/]: {sys.executable}')
+			if DEV_PACKAGE:
+				console.print(f'[bold gold3]Root folder[/]: {ROOT_FOLDER}')
+			console.print(f'[bold gold3]Lib folder[/]: {LIB_FOLDER}')
 		else:
 			ctx.get_help()
 
@@ -142,11 +144,7 @@ def worker(hostname, concurrency, reload, queue, pool, check, dev, stop, show):
 	if reload:
 		patterns = "celery.py;tasks/*.py;runners/*.py;serializers/*.py;output_types/*.py;hooks/*.py;exporters/*.py"
 		cmd = f'watchmedo auto-restart --directory=./ --patterns="{patterns}" --recursive -- {cmd}'
-	Command.run_command(
-		cmd,
-		name='secator worker',
-		**DEFAULT_CMD_OPTS
-	)
+	Command.execute(cmd, name='secator worker')
 
 
 #--------#
@@ -211,11 +209,7 @@ def which(command):
 	Returns:
 		secator.Command: Command instance.
 	"""
-	return Command.run_command(
-		f'which {command}',
-		quiet=True,
-		print_errors=False
-	)
+	return Command.execute(f'which {command}', quiet=True, print_errors=False)
 
 
 def version(cls):
@@ -245,11 +239,7 @@ def get_version(version_cmd):
 		str: Version string.
 	"""
 	regex = r'[0-9]+\.[0-9]+\.?[0-9]*\.?[a-zA-Z]*'
-	ret = Command.run_command(
-		version_cmd,
-		quiet=True,
-		print_errors=False
-	)
+	ret = Command.execute(version_cmd, quiet=True, print_errors=False)
 	match = re.findall(regex, ret.output)
 	if not match:
 		return 'n/a'
@@ -265,7 +255,7 @@ def health(json, debug):
 	status = {'tools': {}, 'languages': {}, 'secator': {}}
 
 	def print_status(cmd, return_code, version=None, bin=None, category=None):
-		s = '[bold green]ok     [/]' if return_code == 0 else '[bold red]failed [/]'
+		s = '[bold green]ok      [/]' if return_code == 0 else '[bold red]missing [/]'
 		s = f'[bold magenta]{cmd:<15}[/] {s} '
 		if return_code == 0 and version:
 			if version == 'N/A':
@@ -287,12 +277,12 @@ def health(json, debug):
 
 	# Check languages
 	console.print('\n:wrench: [bold gold3]Checking installed languages ...[/]')
-	version_cmds = {'go': 'version', 'python3': '--version', 'ruby': '--version', 'rustc': '--version'}
+	version_cmds = {'go': 'version', 'python3': '--version', 'ruby': '--version'}
 	for lang, version_flag in version_cmds.items():
 		ret = which(lang)
 		ret2 = get_version(f'{lang} {version_flag}')
 		if not json:
-			print_status(lang, ret.return_code, ret2, ret.output, 'lang')
+			print_status(lang, ret.return_code, ret2, ret.output, 'langs')
 		status['languages'][lang] = {'installed': ret.return_code == 0}
 
 	# Check tools
@@ -305,6 +295,14 @@ def health(json, debug):
 			print_status(tool.__name__, ret.return_code, ret2, ret.output, 'tools')
 		status['tools'][tool.__name__] = {'installed': ret.return_code == 0}
 
+	# Check addons
+	console.print('\n:wrench: [bold gold3]Checking installed addons ...[/]')
+	for addon in ['google', 'mongodb', 'redis', 'dev', 'trace', 'build']:
+		addon_var = globals()[f'{addon.upper()}_ADDON_ENABLED']
+		ret = 0 if addon_var == 1 else 1
+		bin = None if addon_var == 0 else ' '
+		print_status(addon, ret, 'N/A', bin, 'addons')
+
 	# Print JSON health
 	if json:
 		console.print(status)
@@ -316,12 +314,7 @@ def health(json, debug):
 
 def run_install(cmd, title, next_steps=None):
 	with console.status(f'[bold yellow] Installing {title}...'):
-		ret = Command.run_command(
-			cmd,
-			cls_attributes={'shell': True},
-			print_cmd=True,
-			print_line=True
-		)
+		ret = Command.execute(cmd, cls_attributes={'shell': True}, print_cmd=True, print_line=True)
 		if ret.return_code != 0:
 			console.print(f':exclamation_mark: Failed to install {title}.', style='bold red')
 		else:
@@ -349,7 +342,7 @@ def addons():
 def install_worker():
 	"Install worker addon."
 	run_install(
-		cmd=f'{sys.executable} -m pip install secator[worker]',
+		cmd=f'{sys.executable} -m pip install .[worker]',
 		title='worker addon',
 		next_steps=[
 			'Run "secator worker" to run a Celery worker using the file system as a backend and broker.',
@@ -363,7 +356,7 @@ def install_worker():
 def install_google():
 	"Install google addon."
 	run_install(
-		cmd=f'{sys.executable} -m pip install secator[google]',
+		cmd=f'{sys.executable} -m pip install .[google]',
 		title='google addon',
 		next_steps=[
 			'Set the "GOOGLE_CREDENTIALS_PATH" and "GOOGLE_DRIVE_PARENT_FOLDER_ID" environment variables.',
@@ -376,7 +369,7 @@ def install_google():
 def install_mongodb():
 	"Install mongodb addon."
 	run_install(
-		cmd=f'{sys.executable} -m pip install secator[mongodb]',
+		cmd=f'{sys.executable} -m pip install .[mongodb]',
 		title='mongodb addon',
 		next_steps=[
 			'[dim]\[optional][/] Run "docker run --name mongo -p 27017:27017 -d mongo:latest" to run a local MongoDB instance.',
@@ -390,7 +383,7 @@ def install_mongodb():
 def install_redis():
 	"Install redis addon."
 	run_install(
-		cmd=f'{sys.executable} -m pip install secator[redis]',
+		cmd=f'{sys.executable} -m pip install .[redis]',
 		title='redis addon',
 		next_steps=[
 			'[dim]\[optional][/] Run "docker run --name redis -p 6379:6379 -d redis" to run a local Redis instance.',
@@ -416,6 +409,34 @@ def install_dev():
 	)
 
 
+@addons.command('trace')
+def install_trace():
+	"Install trace addon."
+	run_install(
+		cmd=f'{sys.executable} -m pip install secator[trace]',
+		title='dev addon',
+		next_steps=[
+			'Run "secator test lint" to run lint tests.',
+			'Run "secator test unit" to run unit tests.',
+			'Run "secator test integration" to run integration tests.',
+		]
+	)
+
+
+@addons.command('build')
+def install_build():
+	"Install build addon."
+	run_install(
+		cmd=f'{sys.executable} -m pip install secator[build]',
+		title='build addon',
+		next_steps=[
+			'Run "secator test lint" to run lint tests.',
+			'Run "secator test unit" to run unit tests.',
+			'Run "secator test integration" to run integration tests.',
+		]
+	)
+
+
 @install.group()
 def langs():
 	"Install languages."
@@ -427,7 +448,10 @@ def install_go():
 	"""Install Go."""
 	run_install(
 		cmd='wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/install_go.sh | sudo sh',
-		title='Go'
+		title='Go',
+		next_steps=[
+			'Add ~/go/bin to your $PATH'
+		]
 	)
 
 
@@ -459,21 +483,13 @@ def install_tools(cmds):
 @install.command('cves')
 @click.option('--force', is_flag=True)
 def install_cves(force):
-	"""Install CVEs to file system for passive vulnerability search."""
+	"""Install CVEs (enables passive vulnerability search)."""
 	cve_json_path = f'{CVES_FOLDER}/circl-cve-search-expanded.json'
 	if not os.path.exists(cve_json_path) or force:
 		with console.status('[bold yellow]Downloading zipped CVEs from cve.circl.lu ...[/]'):
-			Command.run_command(
-				'wget https://cve.circl.lu/static/circl-cve-search-expanded.json.gz',
-				cwd=CVES_FOLDER,
-				**DEFAULT_CMD_OPTS
-			)
+			Command.execute('wget https://cve.circl.lu/static/circl-cve-search-expanded.json.gz', cwd=CVES_FOLDER)
 		with console.status('[bold yellow]Unzipping CVEs ...[/]'):
-			Command.run_command(
-				f'gunzip {CVES_FOLDER}/circl-cve-search-expanded.json.gz',
-				cwd=CVES_FOLDER,
-				**DEFAULT_CMD_OPTS
-			)
+			Command.execute(f'gunzip {CVES_FOLDER}/circl-cve-search-expanded.json.gz', cwd=CVES_FOLDER)
 	with console.status(f'[bold yellow]Installing CVEs to {CVES_FOLDER} ...[/]'):
 		with open(cve_json_path, 'r') as f:
 			for line in f:
@@ -591,8 +607,8 @@ def utils():
 @utils.command()
 @click.option('--timeout', type=float, default=0.2, help='Proxy timeout (in seconds)')
 @click.option('--number', '-n', type=int, default=1, help='Number of proxies')
-def get_proxy(timeout, number):
-	"""Get a random proxy."""
+def proxy(timeout, number):
+	"""Get random proxies from FreeProxy."""
 	proxy = FreeProxy(timeout=timeout, rand=True, anonym=True)
 	for _ in range(number):
 		url = proxy.get()
@@ -605,8 +621,9 @@ def get_proxy(timeout, number):
 @click.option('--port', '-p', type=int, default=9001, show_default=True, help='Specify PORT for revshell')
 @click.option('--interface', '-i', type=str, help='Interface to use to detect IP')
 @click.option('--listen', '-l', is_flag=True, default=False, help='Spawn netcat listener on specified port')
-def revshells(name, host, port, interface, listen):
-	"""Show reverse shell source codes and run netcat listener."""
+@click.option('--force', is_flag=True)
+def revshell(name, host, port, interface, listen, force):
+	"""Show reverse shell source codes and run netcat listener (-l)."""
 	if host is None:  # detect host automatically
 		host = detect_host(interface)
 		if not host:
@@ -615,7 +632,18 @@ def revshells(name, host, port, interface, listen):
 				style='bold red')
 			return
 
-	with open(f'{SCRIPTS_FOLDER}/revshells.json') as f:
+	# Download reverse shells JSON from repo
+	revshells_json = f'{REVSHELLS_FOLDER}/revshells.json'
+	if not os.path.exists(revshells_json) or force:
+		ret = Command.execute(
+			f'wget https://raw.githubusercontent.com/freelabz/secator/main/scripts/revshells.json && mv revshells.json {REVSHELLS_FOLDER}',  # noqa: E501
+			cls_attributes={'shell': True}
+		)
+		if not ret.return_code == 0:
+			sys.exit(1)
+
+	# Parse JSON into shells
+	with open(revshells_json) as f:
 		shells = json.loads(f.read())
 		for sh in shells:
 			sh['alias'] = '_'.join(sh['name'].lower()
@@ -663,10 +691,7 @@ def revshells(name, host, port, interface, listen):
 	if listen:
 		console.print(f'Starting netcat listener on port {port} ...', style='bold gold3')
 		cmd = f'nc -lvnp {port}'
-		Command.run_command(
-			cmd,
-			**DEFAULT_CMD_OPTS
-		)
+		Command.execute(cmd)
 
 
 @utils.command()
@@ -675,10 +700,10 @@ def revshells(name, host, port, interface, listen):
 @click.option('--port', '-p', type=int, default=9001, help='HTTP server port')
 @click.option('--interface', '-i', type=str, default=None, help='Interface to use to auto-detect host IP')
 def serve(directory, host, port, interface):
-	"""Serve payloads in HTTP server."""
+	"""Run HTTP server to serve payloads."""
 	LSE_URL = 'https://github.com/diego-treitos/linux-smart-enumeration/releases/latest/download/lse.sh'
 	LINPEAS_URL = 'https://github.com/carlospolop/PEASS-ng/releases/latest/download/linpeas.sh'
-	SUDOKILLER_URL = 'https://raw.githubusercontent.com/TH3xACE/SUDO_KILLER/master/SUDO_KILLERv2.4.2.sh'
+	SUDOKILLER_URL = 'https://raw.githubusercontent.com/TH3xACE/SUDO_KILLER/V3/SUDO_KILLERv3.sh'
 	PAYLOADS = [
 		{
 			'fname': 'lse.sh',
@@ -703,20 +728,11 @@ def serve(directory, host, port, interface):
 			with console.status(f'[bold yellow][{ix}/{len(PAYLOADS)}] Downloading {fname} [dim]({descr})[/] ...[/]'):
 				cmd = payload['command']
 				console.print(f'[bold magenta]{fname} [dim]({descr})[/] ...[/]', )
-				opts = DEFAULT_CMD_OPTS.copy()
-				opts['no_capture'] = False
-				Command.run_command(
-					cmd,
-					cls_attributes={'shell': True},
-					cwd=directory,
-					**opts
-				)
+				Command.execute(cmd, cls_attributes={'shell': True}, cwd=directory)
 		console.print()
 
 	console.print(Rule())
 	console.print(f'Available payloads in {directory}: ', style='bold yellow')
-	opts = DEFAULT_CMD_OPTS.copy()
-	opts['print_cmd'] = False
 	for fname in os.listdir(directory):
 		if not host:
 			host = detect_host(interface)
@@ -731,12 +747,8 @@ def serve(directory, host, port, interface):
 		console.print(f'wget http://{host}:{port}/{fname}', style='dim italic')
 		console.print('')
 	console.print(Rule())
-	console.print('Starting HTTP server ...', style='bold yellow')
-	Command.run_command(
-		f'{sys.executable} -m http.server {port}',
-		cwd=directory,
-		**DEFAULT_CMD_OPTS
-	)
+	console.print(f'Started HTTP server on port {port}, waiting for incoming connections ...', style='bold yellow')
+	Command.execute(f'{sys.executable} -m http.server {port}', cwd=directory)
 
 
 @utils.command()
@@ -772,18 +784,15 @@ def record(record_name, script, interactive, width, height, output_dir):
 			console.print(f'Removed existing {output_cast_path}', style='bold green')
 
 		with console.status('[bold gold3]Recording with asciinema ...[/]'):
-			Command.run_command(
+			Command.execute(
 				f'asciinema-automation -aa "-c /bin/sh" {script} {output_cast_path} --timeout 200',
 				cls_attributes=attrs,
 				raw=True,
-				**DEFAULT_CMD_OPTS,
 			)
 			console.print(f'Generated {output_cast_path}', style='bold green')
 	elif interactive:
 		os.environ.update(attrs['env'])
-		Command.run_command(
-			f'asciinema rec -c /bin/bash --stdin --overwrite {output_cast_path}',
-		)
+		Command.execute(f'asciinema rec -c /bin/bash --stdin --overwrite {output_cast_path}')
 
 	# Resize cast file
 	if os.path.exists(output_cast_path):
@@ -810,11 +819,10 @@ def record(record_name, script, interactive, width, height, output_dir):
 
 		# Edit cast file to reduce long timeouts
 		with console.status('[bold gold3] Editing cast file to reduce long commands ...'):
-			Command.run_command(
+			Command.execute(
 				f'asciinema-edit quantize --range 1 {output_cast_path} --out {output_cast_path}.tmp',
 				cls_attributes=attrs,
 				raw=True,
-				**DEFAULT_CMD_OPTS,
 			)
 			if os.path.exists(f'{output_cast_path}.tmp'):
 				os.replace(f'{output_cast_path}.tmp', output_cast_path)
@@ -822,14 +830,78 @@ def record(record_name, script, interactive, width, height, output_dir):
 
 	# Convert to GIF
 	with console.status(f'[bold gold3]Converting to {output_gif_path} ...[/]'):
-		Command.run_command(
+		Command.execute(
 			f'agg {output_cast_path} {output_gif_path}',
 			cls_attributes=attrs,
-			**DEFAULT_CMD_OPTS,
 		)
 		console.print(f'Generated {output_gif_path}', style='bold green')
 
 
+@utils.group('build')
+def build():
+	"""Build secator."""
+	pass
+
+
+@build.command('pypi')
+def build_pypi():
+	"""Build secator PyPI package."""
+	if not DEV_PACKAGE:
+		console.print('[bold red]You MUST use a development version of secator to make builds.[/]')
+		sys.exit(1)
+	if not BUILD_ADDON_ENABLED:
+		console.print('[bold red]Missing build addon: please run `secator install addons build`')
+		sys.exit(1)
+	with console.status('[bold gold3]Building PyPI package...[/]'):
+		ret = Command.execute(f'{sys.executable} -m hatch build', name='hatch build', cwd=ROOT_FOLDER)
+		sys.exit(ret.return_code)
+
+
+@build.command('docker')
+@click.option('--dev', '-dev', is_flag=True, default=False, help='Build dev version')
+def build_docker(dev):
+	"""Build secator Docker image."""
+	version = 'dev' if dev else VERSION
+	with console.status('[bold gold3]Building Docker image...[/]'):
+		ret = Command.execute(f'docker build -t freelabz/secator:{version} .', name='docker build', cwd=ROOT_FOLDER)
+		sys.exit(ret.return_code)
+
+
+@utils.group('publish')
+def publish():
+	"""Publish secator."""
+	pass
+
+
+@publish.command('pypi')
+def publish_pypi():
+	"""Publish secator PyPI package."""
+	if not DEV_PACKAGE:
+		console.print('[bold red]You MUST use a development version of secator to make builds.[/]')
+		sys.exit(1)
+	if not BUILD_ADDON_ENABLED:
+		console.print('[bold red]Missing build addon: please run `secator install addons build`')
+		sys.exit(1)
+	os.environ['HATCH_INDEX_USER'] = '__token__'
+	hatch_token = os.environ.get('HATCH_INDEX_AUTH')
+	if not hatch_token:
+		console.print('[bold red]Missing PyPI auth token (HATCH_INDEX_AUTH env variable).')
+		sys.exit(1)
+	with console.status('[bold gold3]Publishing PyPI package...[/]'):
+		ret = Command.execute(f'{sys.executable} -m hatch publish', name='hatch publish', cwd=ROOT_FOLDER)
+		sys.exit(ret.return_code)
+
+
+@publish.command('docker')
+@click.option('--dev', '-dev', is_flag=True, default=False, help='Build dev version')
+def publish_docker(dev):
+	"""Publish secator Docker image."""
+	version = 'dev' if dev else VERSION
+	with console.status('[bold gold3]Publishing PyPI package...[/]'):
+		ret = Command.execute(f'docker push freelabz/secator:{version}', name='docker push', cwd=ROOT_FOLDER)
+		sys.exit(ret.return_code)
+
+
 #------#
 # TEST #
 #------#
@@ -854,12 +926,7 @@ def run_test(cmd, name):
 		cmd: Command to run.
 		name: Name of the test.
 	"""
-	result = Command.run_command(
-		cmd,
-		name=name + ' tests',
-		cwd=ROOT_FOLDER,
-		**DEFAULT_CMD_OPTS
-	)
+	result = Command.execute(cmd, name=name + ' tests', cwd=ROOT_FOLDER)
 	if result.return_code == 0:
 		console.print(f':tada: {name.capitalize()} tests passed !', style='bold green')
 	sys.exit(result.return_code)

{secator-0.1.0 → secator-0.2.0}/secator/definitions.py

@@ -10,13 +10,13 @@ load_dotenv(find_dotenv(usecwd=True), override=False)
 # Globals
 VERSION = get_distribution('secator').version
 ASCII = f"""
-                         __            
+			 __            
    ________  _________ _/ /_____  _____
   / ___/ _ \/ ___/ __ `/ __/ __ \/ ___/
  (__  /  __/ /__/ /_/ / /_/ /_/ / /    
 /____/\___/\___/\__,_/\__/\____/_/     v{VERSION}
 
-                    freelabz.com
+			freelabz.com
 """  # noqa: W605,W291
 
 # Secator folders
@@ -157,27 +157,55 @@ WORDS = 'words'
 
 # Check worker addon
 try:
-    import eventlet  # noqa: F401
-    WORKER_ADDON_ENABLED = 1
+	import eventlet  # noqa: F401
+	WORKER_ADDON_ENABLED = 1
 except ModuleNotFoundError:
-    WORKER_ADDON_ENABLED = 0
+	WORKER_ADDON_ENABLED = 0
+
+# Check google addon
+try:
+	import gspread  # noqa: F401
+	GOOGLE_ADDON_ENABLED = 1
+except ModuleNotFoundError:
+	GOOGLE_ADDON_ENABLED = 0
 
 # Check mongodb addon
 try:
-    import pymongo  # noqa: F401
-    MONGODB_ADDON_ENABLED = 1
+	import pymongo  # noqa: F401
+	MONGODB_ADDON_ENABLED = 1
+except ModuleNotFoundError:
+	MONGODB_ADDON_ENABLED = 0
+
+# Check redis addon
+try:
+	import redis  # noqa: F401
+	REDIS_ADDON_ENABLED = 1
 except ModuleNotFoundError:
-    MONGODB_ADDON_ENABLED = 0
+	REDIS_ADDON_ENABLED = 0
 
 # Check dev addon
 try:
-    import flake8  # noqa: F401
-    DEV_ADDON_ENABLED = 1
+	import flake8  # noqa: F401
+	DEV_ADDON_ENABLED = 1
+except ModuleNotFoundError:
+	DEV_ADDON_ENABLED = 0
+
+# Check build addon
+try:
+	import hatch  # noqa: F401
+	BUILD_ADDON_ENABLED = 1
+except ModuleNotFoundError:
+	BUILD_ADDON_ENABLED = 0
+
+# Check trace addon
+try:
+	import memray  # noqa: F401
+	TRACE_ADDON_ENABLED = 1
 except ModuleNotFoundError:
-    DEV_ADDON_ENABLED = 0
+	TRACE_ADDON_ENABLED = 0
 
 # Check dev package
 if not os.path.exists(TESTS_FOLDER):
-    DEV_PACKAGE = 0
+	DEV_PACKAGE = 0
 else:
-    DEV_PACKAGE = 1
+	DEV_PACKAGE = 1