Skip to content

Add an evergreen function to build kubectl plugin and push to S3 #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
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
50 changes: 49 additions & 1 deletion .evergreen-functions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -488,12 +488,60 @@ functions:
- rh_pyxis
binary: scripts/evergreen/run_python.sh scripts/preflight_images.py --image ${image_name} --submit "${preflight_submit}"

# build_multi_cluster_binary:
# - command: subprocess.exec
# type: setup
# params:
# working_dir: src/github.com/mongodb/mongodb-kubernetes
# binary: scripts/evergreen/build_multi_cluster_kubeconfig_creator.sh

install_macnotary:
- command: shell.exec
type: setup
params:
include_expansions_in_env:
- notary_service_url
script: |
set -Eeu pipefail

curl "${notary_service_url}" --output macos-notary.zip
unzip -u macos-notary.zip
chmod 755 ./linux_amd64/macnotary

install_goreleaser:
- command: shell.exec
type: setup
include_expansions_in_env:
- goreleaser_pro_tar_gz
params:
working_dir: src/github.com/mongodb/mongodb-kubernetes
script: |
set -Eeu pipefail
curl -fL "${goreleaser_pro_tar_gz}" --output goreleaser_Linux_x86_64.tar.gz
tar -xf goreleaser_Linux_x86_64.tar.gz
chmod 755 ./goreleaser

build_multi_cluster_binary:
- command: subprocess.exec
type: setup
params:
include_expansions_in_env:
- github_commit
- GRS_USERNAME
- GRS_PASSWORD
- PKCS11_URI
- ARTIFACTORY_URL
- ARTIFACTORY_PASSWORD
- SIGNING_IMAGE_URI
- macos_notary_keyid
- macos_notary_secret
- workdir
- triggered_by_git_tag
env:
MACOS_NOTARY_KEY: ${macos_notary_keyid}
MACOS_NOTARY_SECRET: ${macos_notary_secret}
working_dir: src/github.com/mongodb/mongodb-kubernetes
binary: scripts/evergreen/build_multi_cluster_kubeconfig_creator.sh
binary: scripts/evergreen/run_python.sh scripts/release/kubectl-mongodb/python/build_kubectl_plugin.py

build_and_push_appdb_database:
- command: subprocess.exec
Expand Down
6 changes: 6 additions & 0 deletions .evergreen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ variables:
- func: clone
- func: download_kube_tools
- func: setup_building_host
- func: install_goreleaser
- func: install_macnotary
- func: build_multi_cluster_binary

- &setup_and_teardown_group_gke_code_snippets
Expand All @@ -92,6 +94,8 @@ variables:
- func: setup_gcloud_cli
- func: setup_mongosh
- func: download_kube_tools
- func: install_goreleaser
- func: install_macnotary
- func: build_multi_cluster_binary
teardown_group:
- func: upload_code_snippets_logs
Expand Down Expand Up @@ -420,6 +424,8 @@ tasks:
commands:
- func: clone
- func: setup_building_host
- func: install_goreleaser
- func: install_macnotary
- func: build_multi_cluster_binary
- func: pipeline
vars:
Expand Down
8 changes: 8 additions & 0 deletions scripts/release/kubectl-mongodb/kubectl_mac_notarize.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ if [[ -f "./dist/kubectl-mongodb_darwin_amd64_v1/kubectl-mongodb" && -f "./dist/
-b com.mongodb.mongodb-kubectl-mongodb \
-o ./dist/kubectl-mongodb_macos_signed.zip

echo "printing output zip file content"
unzip -l ./dist/kubectl-mongodb_macos_signed.zip
echo "done"

echo "running unzip -t to verify that the op zip file of macnotary is correct"
unzip -t ./dist/kubectl-mongodb_macos_signed.zip
echo "done"

echo "replacing original files"
unzip -oj ./dist/kubectl-mongodb_macos_signed.zip dist/kubectl-mongodb_darwin_amd64_v1/kubectl-mongodb -d ./dist/kubectl-mongodb_darwin_amd64_v1/
unzip -oj ./dist/kubectl-mongodb_macos_signed.zip dist/kubectl-mongodb_darwin_arm64/kubectl-mongodb -d ./dist/kubectl-mongodb_darwin_arm64/
Expand Down
147 changes: 147 additions & 0 deletions scripts/release/kubectl-mongodb/python/build_kubectl_plugin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
import os
import subprocess
import sys

import boto3
from botocore.exceptions import ClientError, NoCredentialsError, PartialCredentialsError
from mypy.types import ExtraAttrs

# from lib.base_logger import logger

DEV_S3_BUCKET_NAME = "mongodb-kubernetes-dev"
STAGING_S3_BUCKET_NAME = "mongodb-kubernetes-staging"
RELEASE_S3_BUCKET_NAME = "mongodb-kubernetes-release"

AWS_REGION = "eu-north-1"
S3_BUCKET_KUBECTL_PLUGIN_SUBPATH = "kubectl-mongodb"

COMMIT_SHA_ENV_VAR = "github_commit"

GORELEASER_DIST_DIR = "dist"

# LOCAL_FILE_PATHis the full filename where tests image expects the kuebctl-mongodb binary to be available
LOCAL_FILE_PATH = "docker/mongodb-kubernetes-tests/multi-cluster-kube-config-creator_linux"


def run_goreleaser():
try:
command = ["./goreleaser", "build", "--snapshot", "--clean"]

process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, bufsize=1)

for log in iter(process.stdout.readline, ""):
print(log, end="")

process.stdout.close()
exit_code = process.wait()

if exit_code != 0:
print(f"GoReleaser command failed with exit code {exit_code}.")
sys.exit(1)

print("GoReleaser build completed successfully!")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use logger, instead of print.


except FileNotFoundError:
print("ERROR: 'goreleaser' command not found. Please ensure goreleaser is installed and in your system's PATH.")
sys.exit(1)
except Exception as e:
print(f"An unexpected error occurred while running `goreleaser build`: {e}")
sys.exit(1)


def upload_artifacts_to_s3():
if not os.path.isdir(GORELEASER_DIST_DIR):
print(f"ERROR: GoReleaser dist directory '{GORELEASER_DIST_DIR}' not found.")
sys.exit(1)

try:
s3_client = boto3.client("s3", region_name=AWS_REGION)
except (NoCredentialsError, PartialCredentialsError):
print("ERROR: Failed to create S3 client. AWS credentials not found.")
sys.exit(1)
except Exception as e:
print(f"An error occurred connecting to S3: {e}")
sys.exit(1)

uploaded_files = 0
for root, _, files in os.walk(GORELEASER_DIST_DIR):
for filename in files:
local_path = os.path.join(root, filename)
s3_key = s3_path(local_path)

print(f"Uploading artifact {local_path} to s3://{DEV_S3_BUCKET_NAME}/{s3_key}")

stat = os.stat(local_path)
permissions = str(oct(stat.st_mode)[-3:])

try:
s3_client.upload_file(
local_path,
DEV_S3_BUCKET_NAME,
s3_key,
ExtraArgs={
"Metadata": {"posix-permissions": permissions},
},
)
print(f"Successfully uploaded the artifact {filename}")
uploaded_files += 1
except Exception as e:
print(f"ERROR: Failed to upload file {filename}: {e}")

if uploaded_files > 0:
print(f"Successfully uploaded {uploaded_files} kubectl-mongodb plugin artifacts to S3.")


# s3_path returns the path where the artifacts should be uploaded to in S3 obect store.
# For dev workflows it's going to be `kubectl-mongodb/{evg-patch-id}/{goreleaser-artifact}`,
# for staging workflows it would be `kubectl-mongodb/{commit-sha}/{goreleaser-artifact}`.
def s3_path(local_path: str):
commit_sha = os.environ.get(COMMIT_SHA_ENV_VAR, "").strip()
if commit_sha == "":
print(
f"Error: The commit sha environment variable {COMMIT_SHA_ENV_VAR} is not set. It's required to form the S3 Path."
)
sys.exit(1)

return f"{S3_BUCKET_KUBECTL_PLUGIN_SUBPATH}/{commit_sha}/{local_path}"


def download_plugin_for_tests_image():
try:
s3_client = boto3.client("s3", region_name=AWS_REGION)
except Exception as e:
print(f"An error occurred connecting to S3 to download kubectl plugin for tests image: {e}")
return

commit_sha = os.environ.get(COMMIT_SHA_ENV_VAR, "").strip()
if commit_sha == "":
print("Error: The commit sha environment variable is not set. It's required to form the S3 Path.")
sys.exit(1)

plugin_path = f"{S3_BUCKET_KUBECTL_PLUGIN_SUBPATH}/{commit_sha}/dist/kubectl-mongodb_linux_amd64_v1/kubectl-mongodb"

print(f"Downloading s3://{DEV_S3_BUCKET_NAME}/{plugin_path} to {LOCAL_FILE_PATH}")
try:
s3_client.download_file(DEV_S3_BUCKET_NAME, plugin_path, LOCAL_FILE_PATH)
# change the file's permissions so that it can be executed
os.chmod(LOCAL_FILE_PATH, 0o755)

print(f"Successfully downloaded artifact to {LOCAL_FILE_PATH}")
except ClientError as e:
if e.response["Error"]["Code"] == "404":
print(f"ERROR: Artifact not found at s3://{DEV_S3_BUCKET_NAME}/{plugin_path} ")
else:
print(f"ERROR: Failed to download artifact. S3 Client Error: {e}")
except Exception as e:
print(f"An unexpected error occurred during download: {e}")


def main():
run_goreleaser()
upload_artifacts_to_s3()

download_plugin_for_tests_image()


if __name__ == "__main__":
main()