diff --git a/.forgejo/workflows/almalinux:8.yaml b/.forgejo/workflows/almalinux:8.yaml new file mode 100644 index 0000000..119a65d --- /dev/null +++ b/.forgejo/workflows/almalinux:8.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: almalinux:8 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/almalinux:9.yaml b/.forgejo/workflows/almalinux:9.yaml new file mode 100644 index 0000000..1adbd7c --- /dev/null +++ b/.forgejo/workflows/almalinux:9.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: almalinux:9 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/alpine:3.18.yaml b/.forgejo/workflows/alpine:3.18.yaml new file mode 100644 index 0000000..bb87efb --- /dev/null +++ b/.forgejo/workflows/alpine:3.18.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: alpine:3.18 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/alpine:3.19.yaml b/.forgejo/workflows/alpine:3.19.yaml new file mode 100644 index 0000000..98437d5 --- /dev/null +++ b/.forgejo/workflows/alpine:3.19.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: alpine:3.19 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/archlinux:base-20231112.0.191179.yaml b/.forgejo/workflows/archlinux:base-20231112.0.191179.yaml new file mode 100644 index 0000000..be6085d --- /dev/null +++ b/.forgejo/workflows/archlinux:base-20231112.0.191179.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: archlinux:base-20231112.0.191179 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/archlinux:base-20240101.0.204074.yaml b/.forgejo/workflows/archlinux:base-20240101.0.204074.yaml new file mode 100644 index 0000000..0f9a097 --- /dev/null +++ b/.forgejo/workflows/archlinux:base-20240101.0.204074.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: archlinux:base-20240101.0.204074 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/debian:bookworm.yaml b/.forgejo/workflows/debian:bookworm.yaml new file mode 100644 index 0000000..c6f4ae1 --- /dev/null +++ b/.forgejo/workflows/debian:bookworm.yaml @@ -0,0 +1,14 @@ +on: [push] +jobs: + job: + container: + image: debian:bookworm + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace + - run: cd-synchronize diff --git a/.forgejo/workflows/debian:bullseye.yaml b/.forgejo/workflows/debian:bullseye.yaml new file mode 100644 index 0000000..7a1d736 --- /dev/null +++ b/.forgejo/workflows/debian:bullseye.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: debian:bullseye + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/fedora:39.yaml b/.forgejo/workflows/fedora:39.yaml new file mode 100644 index 0000000..aad0848 --- /dev/null +++ b/.forgejo/workflows/fedora:39.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: fedora:39 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/fedora:40.yaml b/.forgejo/workflows/fedora:40.yaml new file mode 100644 index 0000000..fd1d5f9 --- /dev/null +++ b/.forgejo/workflows/fedora:40.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: fedora:40 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/main.yaml b/.forgejo/workflows/main.yaml deleted file mode 100644 index 7bc4877..0000000 --- a/.forgejo/workflows/main.yaml +++ /dev/null @@ -1,7 +0,0 @@ -on: [push] -jobs: - job: - runs-on: bookworm - steps: - - name: cd - run: eval '${{vars.cd}}' diff --git a/.forgejo/workflows/rockylinux:8.yaml b/.forgejo/workflows/rockylinux:8.yaml new file mode 100644 index 0000000..54a1962 --- /dev/null +++ b/.forgejo/workflows/rockylinux:8.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: rockylinux:8 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/rockylinux:9.yaml b/.forgejo/workflows/rockylinux:9.yaml new file mode 100644 index 0000000..64d98a4 --- /dev/null +++ b/.forgejo/workflows/rockylinux:9.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: rockylinux:9 + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/ubuntu:jammy.yaml b/.forgejo/workflows/ubuntu:jammy.yaml new file mode 100644 index 0000000..33c4578 --- /dev/null +++ b/.forgejo/workflows/ubuntu:jammy.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: ubuntu:jammy + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.forgejo/workflows/ubuntu:noble.yaml b/.forgejo/workflows/ubuntu:noble.yaml new file mode 100644 index 0000000..739ca7c --- /dev/null +++ b/.forgejo/workflows/ubuntu:noble.yaml @@ -0,0 +1,13 @@ +on: [push] +jobs: + job: + container: + image: ubuntu:noble + steps: + - name: cd + run: ${{vars.cd}} "${{secrets.cd_ssh_key}}" "${{vars.cd_ssh_hosts}}" + + - run: cd-list-environment + - run: cd-clone-branch + - run: cd-build-project + - run: cd-browse-workspace diff --git a/.gitea b/.gitea new file mode 120000 index 0000000..d9a4b42 --- /dev/null +++ b/.gitea @@ -0,0 +1 @@ +.forgejo \ No newline at end of file diff --git a/.github b/.github new file mode 120000 index 0000000..d9a4b42 --- /dev/null +++ b/.github @@ -0,0 +1 @@ +.forgejo \ No newline at end of file diff --git a/.gitignore b/.gitignore index bee8a64..4a6a1c7 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ __pycache__ +/dist +/.venv diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..a3634f6 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,9 @@ +image: debian:bookworm +job: + script: + - sh ${CD} ${CD_SSH_KEY} ${CD_SSH_HOSTS} + + - cd-list-environment + - cd-clone-branch + - cd-build-project + - cd-browse-workspace diff --git a/.shellcheckrc b/.shellcheckrc new file mode 100644 index 0000000..b1d708a --- /dev/null +++ b/.shellcheckrc @@ -0,0 +1 @@ +enable=all diff --git a/bootstrap.sh b/bootstrap.sh deleted file mode 100755 index e6a0466..0000000 --- a/bootstrap.sh +++ /dev/null @@ -1,42 +0,0 @@ -#! /usr/bin/env bash -FILE="$(realpath "${BASH_SOURCE[0]}")" -ROOT="$(dirname "${FILE}")" - -COMMANDS='cmd' -KEY_ALGORITHM='ed25519' -KEY_DIRECTORY='.ssh' -KEY_PATH="${KEY_DIRECTORY}/id_${KEY_ALGORITHM}" -KEY_PUBLIC='AAAAC3NzaC1lZDI1NTE5AAAAIPHCNcgHlQoiNTXfnUZYvHz9OZwYsmBCrSSV7a7Zche5' -PACKAGES=( -'openssh-client' -'rsync' -'tree' -) -SERVER="$(basename ${GITHUB_SERVER_URL})" -TARGET='/usr/local/sbin' - -# commands -cd "${ROOT}/${COMMANDS}" \ -|| exit -for file in *.sh ; do - cp "${file}" "${TARGET}/${file%.sh}" \ - || exit -done - -# ssh -cd \ -|| exit -mkdir "${KEY_DIRECTORY}" \ -|| exit -echo "${CD}" > "${KEY_PATH}" \ -|| exit -unset CD -chmod '400' "${KEY_PATH}" \ -|| exit -echo "${SERVER} ssh-${KEY_ALGORITHM} ${KEY_PUBLIC}" \ -> "${KEY_DIRECTORY}/known_hosts" \ -|| exit - -# packages -apt-get install --yes "${PACKAGES[@]}" \ -|| exit diff --git a/cd.sh b/cd.sh index 2757fc5..af48a0c 100644 --- a/cd.sh +++ b/cd.sh @@ -1,279 +1,817 @@ #! /usr/bin/env sh -set "cd" "rwx" +# defaults +[ -n "${CD_DNS}" ] || CD_DNS="\ +9.9.9.9 \ +" +[ -n "${CD_GIT_CHILD}" ] || CD_GIT_CHILD="cd" +[ -n "${CD_GIT_PARENT}" ] || CD_GIT_PARENT="rwx" +# main cd_main () { - cd_set_environment - cd_set_dns_resolving \ - "9.9.9.9" + cd_set_environment_variables cd_set_packages_repositories cd_set_packages_configuration + # + cd_list_working_directory cd_set_https_verification_off + cd_set_dns_resolving cd_update_packages_catalog cd_install_packages_tools - cd_install_ca - cd_copy_ca - cd_update_ca + cd_install_ca_certificates + cd_write_ca_certificates + cd_update_ca_certificates cd_set_https_verification_on cd_update_packages_catalog cd_upgrade_packages cd_install_git cd_install_python + # TODO move to Python + cd_install_rsync + # TODO move to Python + cd_install_ssh cd_clean_packages_cache - cd_clone_parent_repositories "${@}" - cd_set_python_commands "${@}" + cd_install_python_modules + cd_write_python_module + cd_switch_to_python "${@}" } -# +# steps -cd_set_environment () { - cd_step "Set environment" - CD_DNS_FILE="/etc/resolv.conf" - case "${CD_OS_NAME}" in - "debian") - CD_PYTHON_COMMAND="python3" - CD_PYTHON_PACKAGES="/usr/lib/python3/dist-packages" +cd_set_environment_variables () { + cd_step "Set environment variables" + # set path + CD_PATH="$(realpath "${0}")" + cd_echo "CD_PATH" + # set operating system id + CD_OS_ID="$(cd_grep_os ID)" + case "${CD_OS_ID}" in + "almalinux") CD_OS_ID="${CD_OS_ALMA}" ;; + "alpine") CD_OS_ID="${CD_OS_ALPINE}" ;; + "arch") CD_OS_ID="${CD_OS_ARCH}" ;; + "debian") CD_OS_ID="${CD_OS_DEBIAN}" ;; + "fedora") CD_OS_ID="${CD_OS_FEDORA}" ;; + "rocky") CD_OS_ID="${CD_OS_ROCKY}" ;; + "ubuntu") CD_OS_ID="${CD_OS_UBUNTU}" ;; + *) cd_error_os "CD_OS_ID" ;; + esac + # set operating system version + case "${CD_OS_ID}" in + "${CD_OS_ALMA}"|"${CD_OS_ARCH}"|"${CD_OS_FEDORA}"|"${CD_OS_ROCKY}") + CD_OS_VERSION=$(cd_grep_os VERSION_ID \ + | sed "s|^\([0-9]\+\)\..*|\1|") + ;; + "${CD_OS_ALPINE}") + CD_OS_VERSION=$(cd_grep_os VERSION_ID \ + | sed "s|^\([0-9]\+\.[0-9]\+\)\..*|\1|") + ;; + "${CD_OS_DEBIAN}"|"${CD_OS_UBUNTU}") + CD_OS_VERSION="$(cd_grep_os VERSION_CODENAME)" + ;; + *) + esac + # check operating system version + case "${CD_OS_ID}" in + "${CD_OS_ALMA}"|"${CD_OS_ROCKY}") case "${CD_OS_VERSION}" in - "bookworm") - echo "TODO" - ;; - *) - echo "CD_OS_VERSION" - exit 2 - ;; + "8"|"9") ;; + *) cd_error_os "CD_OS_VERSION" ;; + esac + ;; + "${CD_OS_ALPINE}") + case "${CD_OS_VERSION}" in + "3.18"|"3.19") ;; + *) cd_error_os "CD_OS_VERSION" ;; + esac + ;; + "${CD_OS_ARCH}") + case "${CD_OS_VERSION}" in + "20231112"|"20240101") ;; + *) cd_error_os "CD_OS_VERSION" ;; + esac + ;; + "${CD_OS_DEBIAN}") + case "${CD_OS_VERSION}" in + "bookworm"|"bullseye") ;; + *) cd_error_os "CD_OS_VERSION" ;; + esac + ;; + "${CD_OS_FEDORA}") + case "${CD_OS_VERSION}" in + "39"|"40") ;; + *) cd_error_os "CD_OS_VERSION" ;; + esac + ;; + "${CD_OS_UBUNTU}") + case "${CD_OS_VERSION}" in + "jammy"|"noble") ;; + *) cd_error_os "CD_OS_VERSION" ;; esac ;; *) - echo "CD_OS_NAME" - exit 1 - ;; esac - # project / branch - [ "${CI_COMMIT_BRANCH}" ] && CD_PROJECT_BRANCH="${CI_COMMIT_BRANCH}" - [ "${GITHUB_REF_NAME}" ] && CD_PROJECT_BRANCH="${GITHUB_REF_NAME}" - if [ ! "${CD_PROJECT_BRANCH}" ] ; then - echo "CD_PROJECT_BRANCH" - exit 3 - fi - # project / name - [ "${CI_PROJECT_PATH}" ] \ - && CD_PROJECT_NAME="$(basename "${CI_PROJECT_PATH}")" - [ "${GITHUB_REPOSITORY}" ] \ - && CD_PROJECT_NAME="$(basename "${GITHUB_REPOSITORY}")" - if [ ! "${CD_PROJECT_NAME}" ] ; then - echo "CD_PROJECT_NAME" - exit 3 - fi - # projects / group - [ "${CI_PROJECT_PATH}" ] \ - && CD_PROJECTS_GROUP="$(dirname "${CI_PROJECT_PATH}")" - [ "${GITHUB_REPOSITORY}" ] \ - && CD_PROJECTS_GROUP="$(dirname "${GITHUB_REPOSITORY}")" - if [ ! "${CD_PROJECTS_GROUP}" ] ; then - echo "CD_PROJECTS_GROUP" - exit 3 - fi - # projects / url - [ "${CI_SERVER_URL}" ] && CD_PROJECTS_URL="${CI_SERVER_URL}" - [ "${GITHUB_SERVER_URL}" ] && CD_PROJECTS_URL="${GITHUB_SERVER_URL}" - if [ "${CD_PROJECTS_URL}" ] ; then - CD_PROJECTS_URL="${CD_PROJECTS_URL}/${CD_PROJECTS_GROUP}" - else - echo "CD_PROJECTS_URL" - exit 3 - fi - # project / url - CD_PROJECT_URL="${CD_PROJECTS_URL}/${CD_PROJECT_NAME}" -} - -cd_set_dns_resolving () { -local server -local text="" - cd_step "Set DNS resolving" - for server in "${@}" ; do - text="${text}nameserver ${server} + cd_split + cd_echo "CD_OS_ID" "CD_OS_VERSION" + # universal + CD_DNS_FILE="/etc/resolv.conf" + CD_PKG_CA="ca-certificates" + CD_PKG_GIT="git" + # TODO move to Python + CD_PKG_RSYNC="rsync" + CD_PYTHON_ALIAS="python3" + cd_split + cd_echo "CD_DNS_FILE" "CD_PKG_CA" "CD_PKG_GIT" "CD_PYTHON_ALIAS" + # set ca command & root + case "${CD_OS_ID}" in + "${CD_OS_ALMA}"|"${CD_OS_FEDORA}"|"${CD_OS_ROCKY}") + CD_CA_ROOT="/etc/pki/ca-trust/source/anchors" + CD_CMD_CA="update-ca-trust" + ;; + "${CD_OS_ALPINE}") + CD_CA_ROOT="/usr/local/share/ca-certificates" + CD_CMD_CA="update-ca-certificates" + ;; + "${CD_OS_ARCH}") + CD_CA_ROOT="/etc/ca-certificates/trust-source/anchors" + CD_CMD_CA="update-ca-trust" + ;; + "${CD_OS_DEBIAN}"|"${CD_OS_UBUNTU}") + CD_CA_ROOT="/usr/local/share/ca-certificates" + CD_CMD_CA="update-ca-certificates" + ;; + *) + esac + cd_split + cd_echo "CD_CA_ROOT" "CD_CMD_CA" + # set package manager + case "${CD_OS_ID}" in + "${CD_OS_ALPINE}") + CD_PM="${CD_PM_APK}" + ;; + "${CD_OS_DEBIAN}"|"${CD_OS_UBUNTU}") + CD_PM="${CD_PM_APT}" + ;; + "${CD_OS_ALMA}"|"${CD_OS_FEDORA}"|"${CD_OS_ROCKY}") + CD_PM="${CD_PM_DNF}" + ;; + "${CD_OS_ARCH}") + CD_PM="${CD_PM_PACMAN}" + ;; + *) + esac + cd_split + cd_echo "CD_PM" + case "${CD_PM}" in + "${CD_PM_DNF}") + CD_PM_CLEAN="dnf clean all" + CD_PM_INSTALL="dnf install --assumeyes" + CD_PM_QUERY="rpm --query" + CD_PM_UPDATE="dnf makecache" + CD_PM_UPGRADE="dnf upgrade --assumeyes" + CD_PKG_PKG="" + CD_PM_CONF_PATH="/etc/dnf/dnf.conf" + CD_PM_CONF_TEXT="\ +[main] +best=True +clean_requirements_on_remove=True +gpgcheck=1 +installonly_limit=3 +skip_if_unavailable=False " - done - cd_write "${CD_DNS_FILE}" "${text}" -} - -cd_set_packages_repositories () { - cd_step "Set packages repositories" - case "${CD_OS_NAME}" in - "debian") - cd_write "/etc/apt/sources.list" "\ -deb https://deb.debian.org/debian bookworm main -deb https://deb.debian.org/debian bookworm-backports main -deb https://deb.debian.org/debian bookworm-updates main -deb https://deb.debian.org/debian-security bookworm-security main + CD_PM_HTTPS_PATH="/etc/dnf/dnf.conf.d/https.conf" + CD_PM_HTTPS_TEXT="\ +sslverify=False " ;; - *) exit 1 ;; - esac -} - -cd_set_packages_configuration () { - cd_step "Set packages configuration" - case "${CD_OS_NAME}" in - "debian") - export DEBIAN_FRONTEND="noninteractive" - cd_write "/etc/apt/apt.conf.d/apt.conf" "\ + "${CD_PM_APK}") + CD_PM_CLEAN="apk cache purge" + CD_PM_INSTALL="apk add" + CD_PM_QUERY="apk info" + CD_PM_UPDATE="apk update" + CD_PM_UPGRADE="apk upgrade" + CD_PKG_PKG="" + CD_PM_CONF_PATH="" + CD_PM_CONF_TEXT="" + CD_PM_HTTPS_PATH="/etc/apk/repositories.d/https" + CD_PM_HTTPS_TEXT="\ +--no-verify +" + ;; + "${CD_PM_PACMAN}") + CD_PM_CLEAN="pacman --sync --clean --noconfirm" + CD_PM_INSTALL="pacman --sync --noconfirm" + CD_PM_QUERY="pacman --query" + CD_PM_UPDATE="pacman --sync --refresh" + CD_PM_UPGRADE="pacman --sync --sysupgrade --noconfirm" + CD_PKG_PKG="" + CD_PM_CONF_PATH="" + CD_PM_CONF_TEXT="" + CD_PM_HTTPS_PATH="/etc/pacman.d/https.conf" + CD_PM_HTTPS_TEXT="\ +SSLVerify = No +" + ;; + "${CD_PM_APT}") + CD_PM_CLEAN="apt-get clean" + CD_PM_INSTALL="apt-get install --assume-yes" + CD_PM_QUERY="dpkg-query --show" + CD_PM_UPDATE="apt-get update" + CD_PM_UPGRADE="apt-get upgrade --assume-yes" + CD_PKG_PKG="apt-utils" + CD_PM_CONF_PATH="/etc/apt/apt.conf.d/apt.conf" + CD_PM_CONF_TEXT="\ Acquire::Check-Valid-Until True; APT::Get::Show-Versions True; APT::Install-Recommends False; APT::Install-Suggests False; Dir::Etc::SourceParts \"\"; " - ;; - *) exit 1 ;; - esac -} - -cd_set_https_verification_off () { - cd_step "Set HTTPS verification off" - case "${CD_OS_NAME}" in - "debian") - cd_write "/etc/apt/apt.conf.d/https" "\ + CD_PM_HTTPS_PATH="/etc/apt/apt.conf.d/https" + CD_PM_HTTPS_TEXT="\ Acquire::https::Verify-Peer False; " ;; - *) exit 1 ;; + *) esac + cd_split + cd_echo "CD_PM_CLEAN" \ + "CD_PM_INSTALL" "CD_PM_QUERY" "CD_PM_UPDATE" "CD_PM_UPGRADE" + cd_split + cd_echo "CD_PKG_PKG" "CD_PM_CONF_PATH" "CD_PM_HTTPS_PATH" + # specific + case "${CD_OS_ID}" in + "${CD_OS_ALMA}") + CD_URL_DEFAULT="https://repo.almalinux.org/almalinux" + ;; + "${CD_OS_ALPINE}") + CD_URL_DEFAULT="https://dl-cdn.alpinelinux.org/alpine" + ;; + "${CD_OS_ARCH}") + CD_URL_DEFAULT="https://geo.mirror.pkgbuild.com" + ;; + "${CD_OS_DEBIAN}") + CD_URL_DEFAULT="http://deb.debian.org/debian" + ;; + "${CD_OS_FEDORA}") + CD_URL_DEFAULT="http://download.example/pub/fedora/linux/releases" + ;; + "${CD_OS_ROCKY}") + CD_URL_DEFAULT="http://dl.rockylinux.org/\$contentdir" + ;; + "${CD_OS_UBUNTU}") + CD_URL_DEFAULT="http://archive.ubuntu.com/ubuntu" + ;; + *) + esac + CD_URL_CHOSEN="${CD_URL_DEFAULT}" + case "${CD_OS_ID}" in + "${CD_OS_ALMA}") + [ -n "${CD_URL_ALMA}" ] && CD_URL_CHOSEN="${CD_URL_ALMA}" + ;; + "${CD_OS_ALPINE}") + [ -n "${CD_URL_ALPINE}" ] && CD_URL_CHOSEN="${CD_URL_ALPINE}" + ;; + "${CD_OS_ARCH}") + [ -n "${CD_URL_ARCH}" ] && CD_URL_CHOSEN="${CD_URL_ARCH}" + ;; + "${CD_OS_DEBIAN}") + [ -n "${CD_URL_DEBIAN}" ] && CD_URL_CHOSEN="${CD_URL_DEBIAN}" \ + || CD_URL_CHOSEN="https://deb.debian.org/debian" + ;; + "${CD_OS_FEDORA}") + [ -n "${CD_URL_FEDORA}" ] && CD_URL_CHOSEN="${CD_URL_FEDORA}" \ + || CD_URL_CHOSEN="https://rpmfind.net/linux/fedora/linux/releases" + ;; + "${CD_OS_ROCKY}") + [ -n "${CD_URL_ROCKY}" ] && CD_URL_CHOSEN="${CD_URL_ROCKY}" \ + || CD_URL_CHOSEN="https://dl.rockylinux.org/\$contentdir" + ;; + "${CD_OS_UBUNTU}") + [ -n "${CD_URL_UBUNTU}" ] && CD_URL_CHOSEN="${CD_URL_UBUNTU}" \ + || CD_URL_CHOSEN="https://ubuntu.mirrors.ovh.net/ubuntu" + ;; + *) + esac + cd_split + cd_echo "CD_URL_DEFAULT" "CD_URL_CHOSEN" + # set python command & package + case "${CD_OS_ID}" in + "${CD_OS_ALMA}"|"${CD_OS_ROCKY}") + CD_PYTHON_COMMAND="python3.11" + CD_PYTHON_PACKAGE="python3.11" + ;; + "${CD_OS_ALPINE}") + CD_PYTHON_COMMAND="python3.11" + CD_PYTHON_PACKAGE="python3" + ;; + "${CD_OS_ARCH}") + CD_PYTHON_COMMAND="python3.12" + CD_PYTHON_PACKAGE="python" + ;; + "${CD_OS_DEBIAN}") + case "${CD_OS_VERSION}" in + "bookworm") CD_PYTHON_COMMAND="python3.11" ;; + "bullseye") CD_PYTHON_COMMAND="python3.9" ;; + *) + esac + CD_PYTHON_PACKAGE="python3" + ;; + "${CD_OS_FEDORA}") + CD_PYTHON_COMMAND="python3.12" + CD_PYTHON_PACKAGE="python3" + ;; + "${CD_OS_UBUNTU}") + case "${CD_OS_VERSION}" in + "noble") CD_PYTHON_COMMAND="python3.12" ;; + "jammy") CD_PYTHON_COMMAND="python3.10" ;; + *) + esac + CD_PYTHON_PACKAGE="python3" + ;; + *) + esac + # set python packages + case "${CD_OS_ID}" in + "${CD_OS_ALMA}"|"${CD_OS_FEDORA}"|"${CD_OS_ROCKY}") + CD_PYTHON_PACKAGES="/usr/lib64/${CD_PYTHON_COMMAND}/site-packages" + ;; + "${CD_OS_ALPINE}"|"${CD_OS_ARCH}") + CD_PYTHON_PACKAGES="/usr/lib/${CD_PYTHON_COMMAND}/site-packages" + ;; + "${CD_OS_DEBIAN}"|"${CD_OS_UBUNTU}") + CD_PYTHON_PACKAGES="/usr/lib/${CD_PYTHON_ALIAS}/dist-packages" + ;; + *) + esac + cd_split + cd_echo "CD_PYTHON_COMMAND" "CD_PYTHON_PACKAGE" "CD_PYTHON_PACKAGES" + # variables + [ -n "${CD_CA_1}" ] && CD_CA=true + # continuous integration platform + if [ -n "${GITHUB_ACTIONS}" ] ; then + # github → gitea → forgejo + if [ -n "${GITHUB_SERVER_URL}" ] ; then + CD_SERVER_URL="${GITHUB_SERVER_URL}" + else + cd_error_ci "GITHUB_SERVER_URL" + fi + if [ -n "${GITHUB_REPOSITORY}" ] ; then + CD_PROJECTS_GROUP="$(dirname "${GITHUB_REPOSITORY}")" + CD_PROJECT_NAME="$(basename "${GITHUB_REPOSITORY}")" + else + cd_error_ci "GITHUB_REPOSITORY" + fi + if [ -n "${GITHUB_REF_NAME}" ] ; then + CD_PROJECT_BRANCH="${GITHUB_REF_NAME}" + else + cd_error_ci "GITHUB_REF_NAME" + fi + elif [ -n "${GITLAB_CI}" ] ; then + # gitlab + if [ -n "${CI_SERVER_URL}" ] ; then + CD_SERVER_URL="${CI_SERVER_URL}" + else + cd_error_ci "CI_SERVER_URL" + fi + if [ -n "${CI_PROJECT_PATH}" ] ; then + CD_PROJECTS_GROUP="$(dirname "${CI_PROJECT_PATH}")" + CD_PROJECT_NAME="$(basename "${CI_PROJECT_PATH}")" + else + cd_error_ci "CI_PROJECT_PATH" + fi + if [ -n "${CI_COMMIT_BRANCH}" ] ; then + CD_PROJECT_BRANCH="${CI_COMMIT_BRANCH}" + else + cd_error_ci "CI_COMMIT_BRANCH" + fi + else + # unsupported + cd_error_ci "ø" + fi + [ -n "${CD_SERVER_URL}" ] || cd_error_ci "CD_SERVER_URL" + [ -n "${CD_PROJECTS_GROUP}" ] || cd_error_ci "CD_PROJECTS_GROUP" + [ -n "${CD_PROJECT_NAME}" ] || cd_error_ci "CD_PROJECT_NAME" + [ -n "${CD_PROJECT_BRANCH}" ] || cd_error_ci "CD_PROJECT_BRANCH" + # + CD_PROJECTS_URL="${CD_SERVER_URL}/${CD_PROJECTS_GROUP}" + # + cd_split + cd_echo "CD_CA" + cd_split + cd_echo "CD_SERVER_URL" \ + "CD_PROJECTS_GROUP" "CD_PROJECT_NAME" "CD_PROJECT_BRANCH" + cd_split + cd_echo "CD_PROJECTS_URL" + # TODO move to Python + case "${CD_PM}" in + "${CD_PM_APK}"|"${CD_PM_APT}") CD_PKG_SSH="openssh-client" ;; + "${CD_PM_DNF}") CD_PKG_SSH="openssh-clients" ;; + "${CD_PM_PACMAN}") CD_PKG_SSH="openssh" ;; + *) + esac +} + +cd_set_packages_repositories () { + cd_step "Set packages repositories" + case "${CD_OS_ID}" in + "${CD_OS_ALMA}") + case "${CD_OS_VERSION}" in + "8") \ +cd_set_packages_repositories__file="/etc/yum.repos.d/almalinux.repo" ;; + "9") \ +cd_set_packages_repositories__file="/etc/yum.repos.d/almalinux-baseos.repo" ;; + *) + esac + cd_sed "${cd_set_packages_repositories__file}" \ + "|^mirrorlist|# mirrorlist|" \ + "|${CD_URL_DEFAULT}|${CD_URL_CHOSEN}|" \ + "|^# baseurl|baseurl|" + ;; + "${CD_OS_ALPINE}") + cd_set_packages_repositories__file="/etc/apk/repositories" + cd_write "${cd_set_packages_repositories__file}" "\ +${CD_URL_CHOSEN}/v${CD_OS_VERSION}/main +${CD_URL_CHOSEN}/v${CD_OS_VERSION}/community +" + ;; + "${CD_OS_DEBIAN}") + cd_set_packages_repositories__file="/etc/apt/sources.list" + cd_write "${cd_set_packages_repositories__file}" "\ +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION} main +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION}-backports main +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION}-updates main +deb ${CD_URL_CHOSEN}-security ${CD_OS_VERSION}-security main +" + ;; + "${CD_OS_ROCKY}") + case "${CD_OS_VERSION}" in + "8") \ +cd_set_packages_repositories__file="/etc/yum.repos.d/Rocky-BaseOS.repo" ;; + "9") \ +cd_set_packages_repositories__file="/etc/yum.repos.d/rocky.repo" ;; + *) + esac + cd_sed "${cd_set_packages_repositories__file}" \ + "|^mirrorlist|# mirrorlist|" \ + "|${CD_URL_DEFAULT}|${CD_URL_CHOSEN}|" \ + "|^#baseurl|baseurl|" + ;; + "${CD_OS_UBUNTU}") + cd_set_packages_repositories__file="/etc/apt/sources.list" + cd_write "${cd_set_packages_repositories__file}" "\ +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION} main +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION}-backports main +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION}-updates main +deb ${CD_URL_CHOSEN} ${CD_OS_VERSION}-security main +" + ;; + *) + esac +} + +cd_set_packages_configuration () { + cd_step "Set packages configuration" + cd_write "${CD_PM_CONF_PATH}" "${CD_PM_CONF_TEXT}" + case "${CD_OS_ID}" in + "${CD_OS_DEBIAN}"|"${CD_OS_UBUNTU}") + export DEBIAN_FRONTEND="noninteractive" + ;; + *) + esac +} + +# agnostic steps + +cd_list_working_directory () { + cd_step "List working directory" + cd_list_working_directory__path="$(realpath .)" + cd_ls "${cd_list_working_directory__path}" +} + +cd_set_https_verification_off () { + if [ -n "${CD_CA}" ] || [ "${CD_PM}" = "${CD_PM_APT}" ] ; then + cd_step "Set HTTPS verification off" + cd_mkdir "$(dirname "${CD_PM_HTTPS_PATH}")" + cd_write "${CD_PM_HTTPS_PATH}" "${CD_PM_HTTPS_TEXT}" + fi +} + +cd_set_dns_resolving () { + cd_step "Set DNS resolving" + for cd_set_dns_resolving__server in ${CD_DNS} ; do + cd_set_dns_resolving__text="${cd_set_dns_resolving__text}\ +nameserver ${cd_set_dns_resolving__server} +" + done + cd_write "${CD_DNS_FILE}" "${cd_set_dns_resolving__text}" } cd_update_packages_catalog () { cd_step "Update packages catalog" - case "${CD_OS_NAME}" in - "debian") apt-get update || exit ;; - *) exit 1 ;; - esac + ${CD_PM_UPDATE} || exit } cd_install_packages_tools () { cd_step "Install packages tools" - case "${CD_OS_NAME}" in - "debian") cd_install_package "apt-utils" ;; - *) exit 1 ;; - esac + cd_install_package "${CD_PKG_PKG}" } -cd_install_ca () { +cd_install_ca_certificates () { cd_step "Install CA" - case "${CD_OS_NAME}" in - "debian") cd_install_package "ca-certificates" ;; - *) exit 1 ;; - esac + cd_install_package "${CD_PKG_CA}" } -cd_copy_ca () { -local target - cd_step "Copy CA" - case "${CD_OS_NAME}" in - "debian") target="/usr/local/share/ca-certificates" ;; - *) exit 1 ;; - esac - # TODO copy +cd_write_ca_certificates () { + cd_step "Write CA certificates" + cd_mkdir "${CD_CA_ROOT}" + cd_write_ca_certificates__index=1 + eval "cd_write_ca_certificates__text=\ +\"\${CD_CA_${cd_write_ca_certificates__index}}\"" + while [ -n "${cd_write_ca_certificates__text}" ] ; do + cd_write_ca_certificates__path="\ +${CD_CA_ROOT}/${cd_write_ca_certificates__index}.crt" + cd_split + cd_write \ + "${cd_write_ca_certificates__path}" \ + "${cd_write_ca_certificates__text}" + cd_openssl "${cd_write_ca_certificates__path}" + cd_write_ca_certificates__index=$((cd_write_ca_certificates__index+1)) + eval "cd_write_ca_certificates__text=\ +\"\${CD_CA_${cd_write_ca_certificates__index}}\"" + done } -cd_update_ca () { - cd_step "Update CA" - case "${CD_OS_NAME}" in - "debian") update-ca-certificates ;; - *) exit 1 ;; - esac +cd_update_ca_certificates () { + cd_step "Update CA certificates" + ${CD_CMD_CA} || exit } cd_set_https_verification_on () { cd_step "Set HTTPS verification on" - case "${CD_OS_NAME}" in - "debian") rm "/etc/apt/apt.conf.d/https" ;; - *) exit 1 ;; - esac + cd_rm "${CD_PM_HTTPS_PATH}" } cd_upgrade_packages () { cd_step "Upgrade packages" - case "${CD_OS_NAME}" in - "debian") apt-get upgrade --yes || exit ;; - *) exit 1 ;; - esac + ${CD_PM_UPGRADE} || exit } cd_install_git () { cd_step "Install Git" - case "${CD_OS_NAME}" in - "debian") cd_install_package "git" ;; - *) exit 1 ;; - esac + cd_install_package "${CD_PKG_GIT}" } cd_install_python () { cd_step "Install Python" - case "${CD_OS_NAME}" in - "debian") cd_install_package "python3" ;; - *) exit 1 ;; - esac + cd_install_package "${CD_PYTHON_PACKAGE}" + cd_split + cd_ln_python "${CD_PYTHON_COMMAND}" +} + +# TODO move to Python +cd_install_rsync () { + cd_step "Install Rsync" + cd_install_package "${CD_PKG_RSYNC}" +} + +# TODO move to Python +cd_install_ssh () { + cd_step "Install SSH" + cd_install_package "${CD_PKG_SSH}" } cd_clean_packages_cache () { cd_step "Clean packages cache" - case "${CD_OS_NAME}" in - "debian") apt-get clean || exit ;; - *) exit 1 ;; - esac + ${CD_PM_CLEAN} || exit } -cd_clone_parent_repositories () { -local repository -local root - cd_step "Clone parent repositories" - root="$(mktemp --directory)" || exit - for repository in "${@}" ; do +cd_install_python_modules () { + cd_step "Install Python modules" + cd_install_python_modules__root="$(mktemp --directory)" || exit + echo "→ ${cd_install_python_modules__root}" + for cd_install_python_modules__repository \ + in "${CD_GIT_CHILD}" "${CD_GIT_PARENT}" ; do + cd_split + cd_install_python_modules__url="\ +${CD_PROJECTS_URL}/${cd_install_python_modules__repository}" + echo "\ +${cd_install_python_modules__url} +↓" git clone \ - "${CD_PROJECTS_URL}/${repository}" "${root}/${repository}" \ + "${cd_install_python_modules__url}" \ + "${cd_install_python_modules__root}\ +/${cd_install_python_modules__repository}" \ || exit + cd_install_python_modules__path="\ +${cd_install_python_modules__root}\ +/${cd_install_python_modules__repository}\ +/${cd_install_python_modules__repository}" + echo "\ +${cd_install_python_modules__path} +↓ +${CD_PYTHON_PACKAGES}" cp --recursive \ - "${root}/${repository}/${repository}" "${CD_PYTHON_PACKAGES}" \ + "${cd_install_python_modules__path}" "${CD_PYTHON_PACKAGES}" \ || exit done - rm --force --recursive "${root}" || exit + cd_split + cd_ls "${CD_PYTHON_PACKAGES}" + cd_split + cd_rm "${cd_install_python_modules__root}" } -cd_set_python_commands () { - cd_step "Set Python commands" - "${CD_PYTHON_COMMAND}" -m "${1}" +cd_write_python_module () { + cd_step "Write Python module" + for cd_write_python_module__variable \ + in OPEN DOWN VERT SPLT __UP SHUT OS_ID OS_VERSION ; do + cd_write_python_module__value="\ +$(cd_echo "CD_${cd_write_python_module__variable}")" + cd_write_python_module__text="${cd_write_python_module__text}\ +${cd_write_python_module__value} +" + done + cd_write "${CD_PYTHON_PACKAGES}/env.py" "${cd_write_python_module__text}\ +CD_STEP = $((CD_STEP+1)) +" } -# +cd_switch_to_python () { + cd_step "Switch to Python" + echo "\ +${CD_PATH} +↓ +${CD_PYTHON_PACKAGES}/${CD_GIT_CHILD}" + "${CD_PYTHON_ALIAS}" -m "${CD_GIT_CHILD}" "${@}" +} + +# functions + +cd_cat () { + cd_cat__file="${1}" + if [ -n "${cd_cat__file}" ] ; then + cd_open "${cd_cat__file}" + cat "${cd_cat__file}" || exit + cd_shut "${cd_cat__file}" + fi +} + +cd_echo () { + if [ -n "${1}" ] ; then + for cd_echo__name in "${@}" ; do + eval "cd_echo__text=\"\${${cd_echo__name}}\"" + echo "${cd_echo__name} = \"${cd_echo__text}\"" + done + fi +} + +cd_error_ci () { + echo "× CI: ${*}" + exit "${CD_ERROR_CI}" +} + +cd_error_os () { + cd_error_os__variable="${1}" + printf "× OS: " + cd_echo "${cd_error_os__variable}" + exit "${CD_ERROR_OS}" +} + +cd_grep_os () { + cd_grep_os__variable="${1}" + if [ -n "${cd_grep_os__variable}" ] ; then + grep "^${cd_grep_os__variable}=" "/etc/os-release" \ + | sed "s|^${cd_grep_os__variable}=||" \ + | sed "s|^\"\(.*\)\"$|\1|" + fi +} cd_install_package () { - if [ "${1}" ] ; then - case "${CD_OS_NAME}" in - "debian") apt-get install --yes "${1}" || exit ;; - *) exit 1 ;; - esac + cd_install_package__name="${1}" + if [ -n "${cd_install_package__name}" ] ; then + ${CD_PM_INSTALL} "${cd_install_package__name}" || exit fi } +cd_ln_python () { + cd_ln_python__command="${1}" + if [ -n "${cd_ln_python__command}" ] ; then + echo "→ ${CD_PYTHON_ALIAS} → ${cd_ln_python__command}" + ln -f -s "${cd_ln_python__command}" "/usr/bin/${CD_PYTHON_ALIAS}" \ + || exit + fi +} + +cd_ls () { + cd_ls__path="${1}" + if [ -n "${cd_ls__path}" ] ; then + cd_open "${cd_ls__path}" + ls -a -l "${cd_ls__path}" || exit + cd_shut "${cd_ls__path}" + fi +} + +cd_mkdir () { + cd_mkdir__path="${1}" + if [ -n "${cd_mkdir__path}" ] ; then + echo "→ ${cd_mkdir__path}" + mkdir --parents "${cd_mkdir__path}" || exit + fi +} + +cd_open () { + echo "${CD_OPEN}${*}" +} + +cd_openssl () { + cd_openssl__file="${1}" + if [ -f "${cd_openssl__file}" ] ; then + openssl x509 \ + -in "${cd_openssl__file}" \ + -noout -text \ + || exit + fi +} + +cd_rm () { + cd_rm__path="${1}" + if [ -e "${cd_rm__path}" ] ; then + echo "← ${cd_rm__path}" + rm -r "${cd_rm__path}" || exit + fi +} + +cd_sed () { + cd_sed__file="${1}" + shift + if [ -f "${cd_sed__file}" ] ; then + cd_cat "${cd_sed__file}" + for cd_sed__regex in "${@}" ; do + sed --in-place "s${cd_sed__regex}g" "${cd_sed__file}" \ + && cd_cat "${cd_sed__file}" \ + || exit + done + fi +} + +cd_shut () { + echo "${CD_SHUT}${*}" +} + +cd_split () { + echo "${CD_SPLT}" +} + cd_step () { - if [ "${1}" ] ; then - CD_STEP=$((CD_STEP+1)) - echo " - ${CD_STEP} ${1} -" - fi + CD_STEP=$((CD_STEP+1)) + echo "\ +${CD_DOWN} +${CD_VERT} ${CD_STEP} ${*} +${CD___UP}" } cd_write () { -local file="${1}" -local text="${2}" - if [ "${file}" ] ; then - echo -n "${text}" \ - > "${file}" \ - || exit + cd_write__file="${1}" + cd_write__text="${2}" + if [ -n "${cd_write__file}" ] ; then + [ -f "${cd_write__file}" ] && cd_cat "${cd_write__file}" + echo "→ ${cd_write__file}" + printf "%s" "${cd_write__text}" > "${cd_write__file}" || exit + cd_cat "${cd_write__file}" fi } -# +# constants +CD_BOX_DOWN="╭" +CD_BOX_LEFT="╴" +CD_BOX_RIGHT="╶" +CD_BOX_UP="╰" +CD_BOX_VERTICAL="│" + +CD_ERROR_CI=2 +CD_ERROR_OS=1 + +CD_OS_ALMA="alma" +CD_OS_ALPINE="alpine" +CD_OS_ARCH="arch" +CD_OS_DEBIAN="debian" +CD_OS_FEDORA="fedora" +CD_OS_ROCKY="rocky" +CD_OS_UBUNTU="ubuntu" + +CD_PM_APK="apk" +CD_PM_APT="apt" +CD_PM_DNF="dnf" +CD_PM_PACMAN="pacman" + +CD_HORIZONTAL="────╌╌╌╌┄┄┄┄┈┈┈┈" + +CD_OPEN="${CD_BOX_DOWN}${CD_BOX_LEFT}" +CD_DOWN="${CD_BOX_DOWN}${CD_HORIZONTAL}" +CD_VERT="${CD_BOX_VERTICAL}" +CD_SPLT="${CD_BOX_RIGHT}${CD_HORIZONTAL}" +CD___UP="${CD_BOX_UP}${CD_HORIZONTAL}" +CD_SHUT="${CD_BOX_UP}${CD_BOX_LEFT}" + +# run cd_main "${@}" diff --git a/cd/__init__.py b/cd/__init__.py index d2b4385..ca3b9c8 100644 --- a/cd/__init__.py +++ b/cd/__init__.py @@ -1,34 +1,159 @@ +"""Continuous Deployment.""" + +__version__ = "0.0.1" + import os +from pathlib import Path + +import env +from rwx import fs, ps +from rwx.log import stream as log from cd.project import Project from cd.projects import Projects -from rwx import ps -COMMANDS_PREFIX = 'cd-' +COMMANDS_PREFIX = "cd-" -projects = Projects(os.environ) +projects = Projects() project = Project(projects) -def cd_clone_branch(): - ps.run('git', - 'clone', - '--branch', project.branch, - '--', +def cd_browse_workspace() -> None: + browse(project.root) + + +def cd_build_project() -> None: + for extension in ["py", "sh"]: + path = Path(project.root) / f"build.{extension}" + if path.exists(): + ps.run(path) + break + else: + pass + + +def cd_clone_branch() -> None: + log.info(projects) + split() + log.info(project) + split() + log.info( + f"""\ +{project.url} +↓ +""", + end="", + flush=True, + ) + ps.run( + "git", + "clone", + "--branch", + project.branch, + "--", project.url, - '.', + project.root, ) -def cd_list_environment(): - for variable, value in sorted(os.environ.items()): - print(variable, '=', value) +def cd_list_environment() -> None: + for variable, value in sorted(projects.environment.items()): + log.info(f"{variable} = {value}") -def install_commands(path): - user = '/usr/local/bin' +def cd_synchronize() -> None: + host = "rwx.work" + source = "out" + user = "cd" + # + root = Path(os.sep) / user / project.branch / projects.group / project.name + # + target = f"{user}@{host}:{root}" + ps.run( + "rsync", + "--archive", + "--delete-before", + "--verbose", + f"{source}/", + f"{target}/", + "--dry-run", + ) + + +def browse(root: str) -> None: + paths = [] + for directory, _, files in os.walk(root): + for file in files: + absolute_path = Path(directory) / file + relative_path = os.path.relpath(absolute_path, start=root) + paths.append(relative_path) + frame(root) + for path in sorted(paths): + log.info(path) + shut(root) + + +def cat(file: str) -> None: + frame(file) + log.info(fs.read_file_text(file).rstrip()) + shut(file) + + +def install_commands(path: str) -> None: + step("Install commands") + user = Path("/usr/local/bin") for command in [ - 'clone-branch', - 'list-environment', + "browse-workspace", + "build-project", + "clone-branch", + "list-environment", + "synchronize", ]: - os.symlink(path, os.path.join(user, f'{COMMANDS_PREFIX}{command}')) + log.info(command) + (user / f"{COMMANDS_PREFIX}{command}").symlink_to(path) + + +def set_ssh(*arguments: str) -> None: + step("Set SSH") + # + ssh_key, ssh_hosts = arguments + # + ssh_type = "ed25519" + # + home = Path("~").expanduser() + # + ssh = home / ".ssh" + ssh.mkdir(exist_ok=True, parents=True) + ssh.chmod(0o700) + # + key = ssh / f"id_{ssh_type}" + if ssh_key: + fs.write(key, ssh_key) + key.chmod(0o400) + # + known = ssh / "known_hosts" + if ssh_hosts: + fs.write(known, ssh_hosts) + known.chmod(0o400) + # + browse(ssh) + cat(known) + + +def frame(text: str) -> None: + log.info(f"{env.CD_OPEN}{text}") + + +def shut(text: str) -> None: + log.info(f"{env.CD_SHUT}{text}") + + +def split() -> None: + log.info(env.CD_SPLT) + + +def step(text: str) -> None: + env.CD_STEP += 1 + log.info(env.CD_DOWN) + log.info(f"{env.CD_VERT} {env.CD_STEP} {text}") + log.info(env.CD___UP) diff --git a/cd/__main__.py b/cd/__main__.py index c93b684..520006a 100755 --- a/cd/__main__.py +++ b/cd/__main__.py @@ -1,17 +1,18 @@ #! /usr/bin/env python3 -import os +"""Entry point to either bootstrap or command.""" + import sys +from pathlib import Path import cd - -if __name__ == '__main__': - command, *arguments = sys.argv - command = os.path.basename(command) - if command == '__main__.py': +if __name__ == "__main__": + path, *arguments = sys.argv + name = Path(path).name + if name == "__main__.py": + cd.set_ssh(*arguments) cd.install_commands(__file__) else: - command = command.replace('-', '_') - function = getattr(cd, command) + function = getattr(cd, name.replace("-", "_")) function(*arguments) diff --git a/cd/project.py b/cd/project.py index b5740e2..d1244d9 100644 --- a/cd/project.py +++ b/cd/project.py @@ -1,17 +1,30 @@ -from os import path +"""CI project.""" + +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING +from urllib.parse import urljoin + +if TYPE_CHECKING: + from cd.projects import Projects BRANCH = [ - 'GITHUB_REF_NAME', - 'CI_COMMIT_BRANCH', + "GITHUB_REF_NAME", + "CI_COMMIT_BRANCH", ] NAME = [ - 'GITHUB_REPOSITORY', - 'CI_PROJECT_PATH', + "GITHUB_REPOSITORY", + "CI_PROJECT_PATH", +] +ROOT = [ + "GITHUB_WORKSPACE", + "CI_PROJECT_DIR", ] class Project: - def __init__(self, projects): + def __init__(self: Project, projects: Projects) -> None: self.projects = projects # branch for variable in BRANCH: @@ -20,6 +33,18 @@ class Project: # name for variable in NAME: if value := projects.environment.get(variable, None): - self.name = path.basename(value) + self.name = Path(value).name + # root + for variable in ROOT: + if value := projects.environment.get(variable, None): + self.root = value # url - self.url = path.join(projects.url, self.name) + self.url = urljoin(projects.url, self.name) + + def __str__(self: Project) -> str: + return f"""\ +branch = {self.branch} + name = {self.name} + root = {self.root} + url = {self.url} +""" diff --git a/cd/projects.py b/cd/projects.py index 81fe3db..e5dd41c 100644 --- a/cd/projects.py +++ b/cd/projects.py @@ -1,23 +1,38 @@ -from os import path +"""CI projects.""" + +from __future__ import annotations + +import os +from pathlib import Path +from urllib.parse import urljoin GROUP_AND_NAME = [ - 'GITHUB_REPOSITORY', - 'CI_PROJECT_PATH', + "GITHUB_REPOSITORY", + "CI_PROJECT_PATH", ] SERVER_URL = [ - 'GITHUB_SERVER_URL', - 'CI_SERVER_URL', + "GITHUB_SERVER_URL", + "CI_SERVER_URL", ] class Projects: - def __init__(self, environment): - self.environment = environment + def __init__(self: Projects) -> None: + self.environment = os.environ # group, name for variable in GROUP_AND_NAME: if value := self.environment.get(variable, None): - self.group, self.name = path.split(value) + path = Path(value) + self.group = str(path.parent) + self.name = path.name # url for variable in SERVER_URL: if value := self.environment.get(variable, None): - self.url = path.join(value, self.group) + self.url = urljoin(value, self.group) + + def __str__(self: Projects) -> str: + return f"""\ +group = {self.group} + name = {self.name} + url = {self.url} +""" diff --git a/cmd/cd-browse-workspace.sh b/cmd/cd-browse-workspace.sh deleted file mode 100755 index b99d6d2..0000000 --- a/cmd/cd-browse-workspace.sh +++ /dev/null @@ -1 +0,0 @@ -tree -a "${GITHUB_WORKSPACE}" diff --git a/cmd/cd-build-project.sh b/cmd/cd-build-project.sh deleted file mode 100755 index 460566e..0000000 --- a/cmd/cd-build-project.sh +++ /dev/null @@ -1,9 +0,0 @@ -if [ -x './build.py' ] ; then - ./build.py \ - || exit -elif [ -x './build.sh' ] ; then - ./build.sh \ - || exit -else - exit -fi diff --git a/cmd/cd-clone-branch.sh b/cmd/cd-clone-branch.sh deleted file mode 100755 index e84ff7b..0000000 --- a/cmd/cd-clone-branch.sh +++ /dev/null @@ -1,8 +0,0 @@ -git clone \ ---branch "${GITHUB_REF_NAME}" \ --- \ -"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \ -'.' - -rm --force --recursive \ -'.git' '.gitignore' diff --git a/cmd/cd-clone-python.sh b/cmd/cd-clone-python.sh deleted file mode 100755 index 52eb00e..0000000 --- a/cmd/cd-clone-python.sh +++ /dev/null @@ -1,15 +0,0 @@ -[ "${1}" ] && REPOSITORY_FULL="${1}" || exit -REPOSITORY_NAME="$(basename ${REPOSITORY_FULL})" - -REPOSITORY_TEMP="$(mktemp --directory)" - -git clone \ --- \ -"${GITHUB_SERVER_URL}/${REPOSITORY_FULL}" \ -"${REPOSITORY_TEMP}" - -mv "${REPOSITORY_TEMP}/${REPOSITORY_NAME}" \ -/usr/local/lib/python3.*/dist-packages/ - -rm --force --recursive \ -"${REPOSITORY_TEMP}" diff --git a/cmd/cd-install-packages.sh b/cmd/cd-install-packages.sh deleted file mode 100755 index af6eefc..0000000 --- a/cmd/cd-install-packages.sh +++ /dev/null @@ -1 +0,0 @@ -apt-get install --yes "${@}" diff --git a/cmd/cd-synchronize.sh b/cmd/cd-synchronize.sh deleted file mode 100755 index 437df02..0000000 --- a/cmd/cd-synchronize.sh +++ /dev/null @@ -1,23 +0,0 @@ -[ "${1}" ] && SYNC_SOURCE="${1}" || exit - -SYNC_USER='cd' - -[ "${GITHUB_SERVER_URL}" ] \ -&& SYNC_HOST="$(basename ${GITHUB_SERVER_URL})" || exit - -[ "${SYNC_USER}" ] \ -&& SYNC_ROOT="/${SYNC_USER}" || exit -[ "${GITHUB_REF_NAME}" ] \ -&& SYNC_ROOT="${SYNC_ROOT}/${GITHUB_REF_NAME}" || exit -[ "${GITHUB_REPOSITORY}" ] \ -&& SYNC_ROOT="${SYNC_ROOT}/${GITHUB_REPOSITORY}" || exit - -SYNC_TARGET="${SYNC_USER}@${SYNC_HOST}:${SYNC_ROOT}" -[ "${2}" ] && SYNC_TARGET="${SYNC_TARGET}/${2}" - -rsync \ ---archive \ ---delete-before \ ---verbose \ -"${SYNC_SOURCE}/" \ -"${SYNC_TARGET}/" diff --git a/license.md b/license.md new file mode 100644 index 0000000..c6f01c6 --- /dev/null +++ b/license.md @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..6027135 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,39 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +authors = [ + { name = "Marc Beninca", email = "git@marc.beninca.link" }, +] +maintainers = [ + { name = "Marc Beninca", email = "git@marc.beninca.link" }, +] +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU Affero General Public License v3", + "Operating System :: OS Independent", +] +dependencies = ["rwx"] +description = "Continuous Deployment" +dynamic = ["version"] +keywords = [] +license-files = { paths = ["license.md"] } +name = "cd" +readme = "readme.md" +requires-python = ">= 3.10" + +[project.scripts] +# command = "package.module:function" + +[project.urls] + +[tool.hatch.version] +path = "cd/__init__.py" + +[tool.ruff] +line-length = 80 + +[tool.ruff.lint] +ignore = ["COM812", "D203", "D213", "ISC001"] +select = ["ALL"] diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b6a1738 --- /dev/null +++ b/readme.md @@ -0,0 +1,101 @@ +# Continuous Deployment + +Get a common set of Python CI/CD commands \ +from various contexts of CA, CI and OCI / OS. + +## Features + +* [X] CA certificates + * [X] custom + * [X] known +* [ ] Continuous Integration platforms + * [X] ForgeJo + * [ ] Gitea + * [ ] GitHub + * [X] GitLab + * [ ] SourceHut +* [X] Operating Systems + * [X] Alma → Python 3.11 + * [X] 8 + * [X] 9 + * [X] Alpine → Python 3.11 + * [X] 3.18 + * [X] 3.19 + * [X] Arch → Python 3.12 + * [ ] 20231112 + * [X] 20240101 + * [X] Debian + * [ ] Bullseye (11) → Python 3.9 + * [X] Bookworm (12) → Python 3.11 + * [X] Fedora → Python 3.12 + * [X] 39 + * [X] 40 + * [X] Rocky → Python 3.11 + * [X] 8 + * [X] 9 + * [X] Ubuntu + * [X] Jammy (22.04) → Python 3.10 + * [X] Noble (24.04) → Python 3.12 + +## How + +| Variable | Description | Default | +|:--------------|:------------------------|:--------------------------------| +| CD_CA_n | Numbered CA certificate | | +| CD_DNS | Space separated servers | 9.9.9.9 | +| CD_GIT_CHILD | Child Git repository | cd | +| CD_GIT_PARENT | Parent Git repository | rwx | +| CD_SSH_HOSTS | domain.tld ssh-type pub | | +| CD_SSH_KEY | SSH private key | | +| CD_URL_ALMA | Alma repository URL | https://repo.almalinux.org | +| CD_URL_ALPINE | Alpine repository URL | https://dl-cdn.alpinelinux.org | +| CD_URL_ARCH | Arch repository URL | https://geo.mirror.pkgbuild.com | +| CD_URL_DEBIAN | Debian repository URL | https://deb.debian.org | +| CD_URL_FEDORA | Fedora repository URL | https://rpmfind.net | +| CD_URL_ROCKY | Rocky repository URL | https://dl.rockylinux.org | +| CD_URL_UBUNTU | Ubuntu repository URL | https://ubuntu.mirrors.ovh.net | + +## HTTPS & Python + +| OS img | crt | upd | Python | +|:--------|-----|-----|:-------| +| Alma 8 | ☑ | ☑ | ☐ | +| Alma 9 | ☑ | ☑ | ☑ 3.9 | +| Alpine | ☑ | ☐ | ☐ | +| Arch | ☑ | ☑ | ☐ | +| Debian | ☐ | ☐ | ☐ | +| Fedora | ☑ | ☑ | ☑ 3.12 | +| Rocky 8 | ☑ | ☑ | ☐ | +| Rocky 9 | ☑ | ☑ | ☑ 3.9 | +| Ubuntu | ☐ | ☐ | ☐ | + +## Tasks + +* relay environment module name +* show previous states of directories & files +* test with github +* test with gitea +* write tests + +### .py + +* detect ssh private key type +* implement project repository cloning +* install + * epel + * shellcheck + * openssh + * pip + * ruff + * rsync +* lint + * .py + * .sh +* write bootstrap entry point + +### .sh + +* handle git cloning credentials +* override repository and framework locations +* reduce single conditions with && +* support opensuse