From 83e1b9af2bf8f5e0b97b2a3b4b69bd321cc1eb16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=BCller?= Date: Thu, 11 Apr 2024 18:15:44 +0200 Subject: [PATCH] Makefile: support for golang debugging --- Makefile | 12 +- cmd/image-builder/main.go | 2 +- distribution/Dockerfile-ubi_srcinstall | 37 ++++ distribution/openshift-startup.sh | 6 + .../pkg/splunk_logger/LICENSE | 201 ------------------ 5 files changed, 52 insertions(+), 206 deletions(-) create mode 100644 distribution/Dockerfile-ubi_srcinstall delete mode 100644 vendor/github.com/osbuild/osbuild-composer/pkg/splunk_logger/LICENSE diff --git a/Makefile b/Makefile index b72fb264d..31a8637c3 100644 --- a/Makefile +++ b/Makefile @@ -83,7 +83,7 @@ SRC_DEPS_EXTERNAL_CHECKOUT_DIR ?= ../ # podman needs to build as root as it also needs to run as root afterwards CONTAINER_EXECUTABLE ?= sudo podman DOCKER_IMAGE := image-builder_devel -DOCKERFILE := distribution/Dockerfile-ubi +DOCKERFILE := distribution/Dockerfile-ubi_srcinstall SRC_DEPS_EXTERNAL_NAMES := community-gateway osbuild-composer SRC_DEPS_EXTERNAL_DIRS := $(addprefix $(SRC_DEPS_EXTERNAL_CHECKOUT_DIR),$(SRC_DEPS_EXTERNAL_NAMES)) @@ -91,15 +91,19 @@ SRC_DEPS_EXTERNAL_DIRS := $(addprefix $(SRC_DEPS_EXTERNAL_CHECKOUT_DIR),$(SRC_DE SRC_DEPS_DIRS := internal cmd # All files to check for rebuild! -SRC_DEPS := $(shell find $(SRC_DEPS_DIRS) -name *.go) +SRC_DEPS := $(shell find $(SRC_DEPS_DIRS) -name *.go -or -name *.sql) SRC_DEPS_EXTERNAL := $(shell find $(SRC_DEPS_EXTERNAL_DIRS) -name *.go) +CONTAINER_DEPS := ./distribution/openshift-startup.sh + $(SRC_DEPS_EXTERNAL_DIRS): @for DIR in $@; do if ! [ -d $$DIR ]; then echo "Please checkout $$DIR so it is available at $$DIR"; exit 1; fi; done GOPROXY ?= https://proxy.golang.org,direct GOMODARGS ?= -modfile=go.local.mod +# gcflags "-N -l" for golang to allow debugging +GCFLAGS ?= -gcflags=all=-N -gcflags=all=-l go.local.mod go.local.sum: $(SRC_DEPS_EXTERNAL_DIRS) go.mod $(SRC_DEPS_EXTERNAL) $(SRC_DEPS) cp go.mod go.local.mod @@ -108,8 +112,8 @@ go.local.mod go.local.sum: $(SRC_DEPS_EXTERNAL_DIRS) go.mod $(SRC_DEPS_EXTERNAL) go mod edit $(GOMODARGS) -replace github.com/osbuild/community-gateway=$(SRC_DEPS_EXTERNAL_CHECKOUT_DIR)community-gateway env GOPROXY=$(GOPROXY) go mod vendor $(GOMODARGS) -container_built.info: go.local.mod $(DOCKERFILE) $(SRC_DEPS) - $(CONTAINER_EXECUTABLE) build -t $(DOCKER_IMAGE) -f $(DOCKERFILE) --build-arg GOMODARGS=$(GOMODARGS) . +container_built.info: go.local.mod $(DOCKERFILE) $(CONTAINER_DEPS) $(SRC_DEPS) + $(CONTAINER_EXECUTABLE) build -t $(DOCKER_IMAGE) -f $(DOCKERFILE) --build-arg GOMODARGS="$(GOMODARGS)" --build-arg GCFLAGS="$(GCFLAGS)" . echo "Container last built on" > $@ date >> $@ diff --git a/cmd/image-builder/main.go b/cmd/image-builder/main.go index c7ac3024a..94a4390f6 100644 --- a/cmd/image-builder/main.go +++ b/cmd/image-builder/main.go @@ -173,7 +173,7 @@ func main() { panic(err) } - logrus.Infof("🚀 Starting image-builder built %s sha %s server on %v ...\n", common.BuildTime, common.BuildCommit, conf.ListenAddress) + logrus.Infof("🚀 Starting image-builder built %s sha %s server on %v ...", common.BuildTime, common.BuildCommit, conf.ListenAddress) err = echoServer.Start(conf.ListenAddress) if err != nil { panic(err) diff --git a/distribution/Dockerfile-ubi_srcinstall b/distribution/Dockerfile-ubi_srcinstall new file mode 100644 index 000000000..e4f5ee280 --- /dev/null +++ b/distribution/Dockerfile-ubi_srcinstall @@ -0,0 +1,37 @@ +# Use a builder container to build the Go application (which we extract in +# the second container). +FROM registry.access.redhat.com/ubi9/go-toolset:latest AS builder +WORKDIR $GOPATH/go/src/github.com/osbuild/image-builder +# ubi9/go-toolset defaults to uid 1001. Let's copy the files with this UID as well. +# Otherwise, VCS stamping will fail because git >= 2.35.2 refuses to work in +# a repository owned by a different user. +COPY --chown=1001 . . +ENV GOFLAGS=-mod=vendor + +ARG GOPROXY=https://proxy.golang.org,direct +RUN go env -w GOPROXY=$GOPROXY + +ARG GOMODARGS="" +ARG GCFLAGS="" + +RUN go install $GOMODARGS $GCFLAGS ./... + +FROM registry.access.redhat.com/ubi9/go-toolset:latest AS builder2 +RUN go install github.com/jackc/tern@latest + +# Build an extremely minimal container that only contains our Go application. +FROM registry.access.redhat.com/ubi9/ubi-minimal:latest +RUN mkdir /app +RUN mkdir -p "/opt/migrate/" + +COPY --from=builder /opt/app-root/src/go/bin/image-builder /app/ +COPY --from=builder /opt/app-root/src/go/bin/image-builder-migrate-db-tern /app/ +COPY ./distributions /app/distributions +COPY ./internal/db/migrations-tern /app/migrations +COPY ./distribution/openshift-startup.sh /opt/openshift-startup.sh +COPY --from=builder2 /opt/app-root/src/go/bin/tern /opt/migrate/ +COPY --from=builder2 /usr/bin/dlv /usr/bin/dlv +COPY --from=builder2 /usr/share/licenses/delve /usr/share/licenses/delve +ENV TERN_MIGRATIONS_DIR=/app/migrations +EXPOSE 8086 +CMD ["/opt/openshift-startup.sh"] diff --git a/distribution/openshift-startup.sh b/distribution/openshift-startup.sh index 4794d252e..6bcbe8aa0 100755 --- a/distribution/openshift-startup.sh +++ b/distribution/openshift-startup.sh @@ -3,6 +3,12 @@ set -euo pipefail if [[ -z "${KUBERNETES_PORT:-}" ]]; then echo "Starting image-builder inside container..." + if [[ -n "${GODEBUG_PORT:-}" ]]; then + echo "With golang debugger enabled on port ${GODEBUG_PORT} ..." + echo "NOTE: you HAVE to attach the debugger NOW otherwise the image-builder-backend will not continue running" + /usr/bin/dlv "--listen=:${GODEBUG_PORT}" --headless=true --api-version=2 exec /app/image-builder -- -v + exit $? + fi # we don't use cloudwatch in ephemeral environment for now elif [[ "${CLOWDER_ENABLED:=false}" == "true" ]]; then echo "Starting image-builder inside ephemeral environment..." diff --git a/vendor/github.com/osbuild/osbuild-composer/pkg/splunk_logger/LICENSE b/vendor/github.com/osbuild/osbuild-composer/pkg/splunk_logger/LICENSE deleted file mode 100644 index 261eeb9e9..000000000 --- a/vendor/github.com/osbuild/osbuild-composer/pkg/splunk_logger/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License.