Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/site/
__pycache__
190 changes: 190 additions & 0 deletions fpo.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
from dataclasses import dataclass, field

import yaml

# OS-specific packages use this path
DEBIAN_RELEASE = 'bookworm'
PACKAGING_URL = 'https://github.com/theforeman/foreman-packaging'


@dataclass
class Entry:
short_name: str
name: str | None = None
url: str | None = None
github_org: str = 'theforeman'
installer: bool = True
description: str | None = None

@property
def ci_badges(self):
return []

def __post_init__(self):
if not self.name:
self.name = self.short_name
if not self.url:
self.url = f'https://github.com/{self.github_org}/{self.name}'


class PuppetModule(Entry): # pylint: disable=too-few-public-methods
@property
def ci_badges(self):
url = f'{self.url}/actions/workflows/ci.yml'
return [f"[![CI]({url}/badge.svg)]({url})"]

def __post_init__(self):
if not self.name:
self.name = f'puppet-{self.short_name}'
super().__post_init__()


@dataclass
class PackagedEntry(Entry):
rpm: str | None = None
rpm_directory: str = 'plugins'
deb: str | None = None
puppet_acceptance_tests: str | None = None
translations: str | None | bool = None
github_team: str | None = None
satellite: bool | None = False
tests: dict = field(default_factory=dict)

def __post_init__(self):
super().__post_init__()

if self.rpm is True:
self.rpm = f'rubygem-{self.name}'
if self.deb is True:
self.deb = f'ruby-{self.name.replace("_", "-")}'

if self.translations is True:
self.translations = f'https://app.transifex.com/foreman/foreman/{self.name}/'
elif self.translations:
self.translations = f'https://app.transifex.com/foreman/foreman/{self.translations}/'

@property
def github_team_url(self):
if not self.github_team:
return None
org, name = self.github_team.split('/')
return f'https://github.com/orgs/{org}/teams/{name}'

@property
def rpm_url(self):
if not self.rpm:
return None
return f'{PACKAGING_URL}/tree/rpm/develop/packages/{self.rpm_directory}/{self.rpm}'

@property
def deb_url(self):
if not self.deb:
return None
return f'{PACKAGING_URL}/tree/deb/develop/plugins/{self.deb}'

@property
def puppet_module(self):
return None # implemented by a subclass

@property
def puppet_acceptance_tests_url(self):
if not self.puppet_acceptance_tests:
return None
return f'https://github.com/theforeman/{self.puppet_module}/tree/master/spec/acceptance/{self.puppet_acceptance_tests}_spec.rb' # pylint: disable=line-too-long

@property
def github_test_urls(self):
return [(f'GitHub {label}', f'{self.url}/actions/workflows/{test}') for (label, test) in self.tests.get('github', {}).items()]

@property
def jenkins_test_urls(self):
if not self.tests.get('jenkins'):
return []
return [('Jenkins', f'https://ci.theforeman.org/job/{self.tests["jenkins"]}')]

@property
def puppet_test_urls(self):
return [('Puppet', self.puppet_acceptance_tests_url)]

@property
def test_urls(self):
return [(label, url) for (label, url) in (self.puppet_test_urls + self.github_test_urls + self.jenkins_test_urls) if url]


class ForemanPlugin(PackagedEntry):
def __post_init__(self):
if not self.name:
self.name = f'foreman_{self.short_name}'
super().__post_init__()

@property
def puppet_module(self):
return 'puppet-foreman'


class SmartProxyPlugin(PackagedEntry): # pylint: disable=too-few-public-methods
def __post_init__(self):
if not self.name:
self.name = f'smart_proxy_{self.short_name}'
if self.deb is True:
self.deb = self.name.replace("-", "_")
if self.puppet_acceptance_tests is True:
self.puppet_acceptance_tests = self.short_name
super().__post_init__()

@property
def puppet_module(self):
return 'puppet-foreman_proxy'

class HammerPlugin(PackagedEntry):
def __post_init__(self):
if not self.name:
self.name = f'hammer_cli_{self.short_name}'
if not self.url:
# A lot of repos use dashes, unlike the gem name
self.url = f'https://github.com/{self.github_org}/hammer-cli-{self.short_name.replace("_", "-")}'
if self.deb is True:
self.deb = self.name.replace("-", "_")
if self.puppet_acceptance_tests is None:
self.puppet_acceptance_tests = True
super().__post_init__()

@property
def deb_url(self):
if not self.deb:
return None
return f'{PACKAGING_URL}/tree/deb/develop/dependencies/{DEBIAN_RELEASE}/{self.deb}'

@property
def puppet_module(self):
return 'puppet-foreman'

@property
def puppet_acceptance_tests_url(self):
if not self.puppet_acceptance_tests:
return None
return f'https://github.com/theforeman/{self.puppet_module}/tree/master/spec/acceptance/foreman_cli_plugins_spec.rb' # pylint: disable=line-too-long


def load_config(config):
data = yaml.safe_load(config)

data['cli']['plugins'] = [HammerPlugin(short_name=plugin_id, **(plugin or {}))
for plugin_id, plugin in data['cli']['plugins'].items()]

data['foreman']['plugins'] = [ForemanPlugin(short_name=plugin_id, **(plugin or {}))
for plugin_id, plugin in data['foreman']['plugins'].items()]

data['smart_proxy']['modules'] = [SmartProxyPlugin(short_name=module_id, **(module or {}))
for module_id, module in data['smart_proxy']['modules'].items()]

data['smart_proxy']['providers'] = [SmartProxyPlugin(short_name=provider_id, **(provider or {}))
for provider_id, provider in data['smart_proxy']['providers'].items()]

data['installer']['modules'] = [PuppetModule(short_name=module_id, **(module or {}))
for module_id, module in data['installer']['modules'].items()]

data['auxiliary'] = [Entry(short_name=repository_id, **(repository or {}))
for repository_id, repository in data['auxiliary'].items()]

return data
192 changes: 2 additions & 190 deletions process
Original file line number Diff line number Diff line change
Expand Up @@ -2,197 +2,9 @@

import argparse
import json
from dataclasses import asdict, dataclass, field

import yaml

# OS-specific packages use this path
DEBIAN_RELEASE = 'bookworm'
PACKAGING_URL = 'https://github.com/theforeman/foreman-packaging'


@dataclass
class Entry:
short_name: str
name: str | None = None
url: str | None = None
github_org: str = 'theforeman'
installer: bool = True
description: str | None = None

@property
def ci_badges(self):
return []

def __post_init__(self):
if not self.name:
self.name = self.short_name
if not self.url:
self.url = f'https://github.com/{self.github_org}/{self.name}'


class PuppetModule(Entry): # pylint: disable=too-few-public-methods
@property
def ci_badges(self):
url = f'{self.url}/actions/workflows/ci.yml'
return [f"[![CI]({url}/badge.svg)]({url})"]

def __post_init__(self):
if not self.name:
self.name = f'puppet-{self.short_name}'
super().__post_init__()


@dataclass
class PackagedEntry(Entry):
rpm: str | None = None
rpm_directory: str = 'plugins'
deb: str | None = None
puppet_acceptance_tests: str | None = None
translations: str | None | bool = None
github_team: str | None = None
satellite: bool | None = False
tests: dict = field(default_factory=dict)

def __post_init__(self):
super().__post_init__()

if self.rpm is True:
self.rpm = f'rubygem-{self.name}'
if self.deb is True:
self.deb = f'ruby-{self.name.replace("_", "-")}'

if self.translations is True:
self.translations = f'https://app.transifex.com/foreman/foreman/{self.name}/'
elif self.translations:
self.translations = f'https://app.transifex.com/foreman/foreman/{self.translations}/'

@property
def github_team_url(self):
if not self.github_team:
return None
org, name = self.github_team.split('/')
return f'https://github.com/orgs/{org}/teams/{name}'

@property
def rpm_url(self):
if not self.rpm:
return None
return f'{PACKAGING_URL}/tree/rpm/develop/packages/{self.rpm_directory}/{self.rpm}'

@property
def deb_url(self):
if not self.deb:
return None
return f'{PACKAGING_URL}/tree/deb/develop/plugins/{self.deb}'

@property
def puppet_module(self):
return None # implemented by a subclass

@property
def puppet_acceptance_tests_url(self):
if not self.puppet_acceptance_tests:
return None
return f'https://github.com/theforeman/{self.puppet_module}/tree/master/spec/acceptance/{self.puppet_acceptance_tests}_spec.rb' # pylint: disable=line-too-long

@property
def github_test_urls(self):
return [(f'GitHub {label}', f'{self.url}/actions/workflows/{test}') for (label, test) in self.tests.get('github', {}).items()]

@property
def jenkins_test_urls(self):
if not self.tests.get('jenkins'):
return []
return [('Jenkins', f'https://ci.theforeman.org/job/{self.tests["jenkins"]}')]

@property
def puppet_test_urls(self):
return [('Puppet', self.puppet_acceptance_tests_url)]

@property
def test_urls(self):
return [(label, url) for (label, url) in (self.puppet_test_urls + self.github_test_urls + self.jenkins_test_urls) if url]


class ForemanPlugin(PackagedEntry):
def __post_init__(self):
if not self.name:
self.name = f'foreman_{self.short_name}'
super().__post_init__()

@property
def puppet_module(self):
return 'puppet-foreman'


class SmartProxyPlugin(PackagedEntry): # pylint: disable=too-few-public-methods
def __post_init__(self):
if not self.name:
self.name = f'smart_proxy_{self.short_name}'
if self.deb is True:
self.deb = self.name.replace("-", "_")
if self.puppet_acceptance_tests is True:
self.puppet_acceptance_tests = self.short_name
super().__post_init__()

@property
def puppet_module(self):
return 'puppet-foreman_proxy'

class HammerPlugin(PackagedEntry):
def __post_init__(self):
if not self.name:
self.name = f'hammer_cli_{self.short_name}'
if not self.url:
# A lot of repos use dashes, unlike the gem name
self.url = f'https://github.com/{self.github_org}/hammer-cli-{self.short_name.replace("_", "-")}'
if self.deb is True:
self.deb = self.name.replace("-", "_")
if self.puppet_acceptance_tests is None:
self.puppet_acceptance_tests = True
super().__post_init__()

@property
def deb_url(self):
if not self.deb:
return None
return f'{PACKAGING_URL}/tree/deb/develop/dependencies/{DEBIAN_RELEASE}/{self.deb}'

@property
def puppet_module(self):
return 'puppet-foreman'

@property
def puppet_acceptance_tests_url(self):
if not self.puppet_acceptance_tests:
return None
return f'https://github.com/theforeman/{self.puppet_module}/tree/master/spec/acceptance/foreman_cli_plugins_spec.rb' # pylint: disable=line-too-long


def load_config(config):
data = yaml.safe_load(config)

data['cli']['plugins'] = [HammerPlugin(short_name=plugin_id, **(plugin or {}))
for plugin_id, plugin in data['cli']['plugins'].items()]

data['foreman']['plugins'] = [ForemanPlugin(short_name=plugin_id, **(plugin or {}))
for plugin_id, plugin in data['foreman']['plugins'].items()]

data['smart_proxy']['modules'] = [SmartProxyPlugin(short_name=module_id, **(module or {}))
for module_id, module in data['smart_proxy']['modules'].items()]

data['smart_proxy']['providers'] = [SmartProxyPlugin(short_name=provider_id, **(provider or {}))
for provider_id, provider in data['smart_proxy']['providers'].items()]

data['installer']['modules'] = [PuppetModule(short_name=module_id, **(module or {}))
for module_id, module in data['installer']['modules'].items()]

data['auxiliary'] = [Entry(short_name=repository_id, **(repository or {}))
for repository_id, repository in data['auxiliary'].items()]

return data

from dataclasses import asdict
from fpo import load_config, Entry

def markdown_link(label, url):
return f'[{label}]({url})' if url else '—'
Expand Down