From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 92D62138334 for ; Wed, 18 Sep 2019 20:29:22 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 534A6E09EC; Wed, 18 Sep 2019 20:29:19 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id EF79BE09AE for ; Wed, 18 Sep 2019 20:29:18 +0000 (UTC) Received: from pomiot (c134-66.icpnet.pl [85.221.134.66]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: mgorny) by smtp.gentoo.org (Postfix) with ESMTPSA id 59F0934B382; Wed, 18 Sep 2019 20:29:17 +0000 (UTC) Message-ID: Subject: Re: [gentoo-dev] [PATCH 1/1] go-module.eclass: introduce new eclass to handle go modules From: =?UTF-8?Q?Micha=C5=82_G=C3=B3rny?= To: gentoo-dev@lists.gentoo.org Cc: William Hubbs Date: Wed, 18 Sep 2019 22:29:12 +0200 In-Reply-To: <20190918202631.8667-2-williamh@gentoo.org> References: <20190918202631.8667-1-williamh@gentoo.org> <20190918202631.8667-2-williamh@gentoo.org> Organization: Gentoo Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-r1Qk0A4fsWHCUyy39M8d" User-Agent: Evolution 3.32.4 Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 X-Archives-Salt: f9dc8473-7236-43cb-be1d-1b63b7c20c02 X-Archives-Hash: 6a6b9f8bf54e99bbfb3971951cfe2eca --=-r1Qk0A4fsWHCUyy39M8d Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Wed, 2019-09-18 at 15:26 -0500, William Hubbs wrote: > Signed-off-by: William Hubbs > --- > eclass/go-module.eclass | 161 ++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 161 insertions(+) > create mode 100644 eclass/go-module.eclass >=20 > diff --git a/eclass/go-module.eclass b/eclass/go-module.eclass > new file mode 100644 > index 00000000000..6f609e94542 > --- /dev/null > +++ b/eclass/go-module.eclass > @@ -0,0 +1,161 @@ > +# Copyright 2019 gentoo authors > +# Distributed under the terms of the GNU General Public License v2 > + > +# @ECLASS: go-module.eclass > +# @MAINTAINER: > +# William Hubbs > +# @SUPPORTED_EAPIS: 7 > +# @BLURB: basic eclass for building software written in the go > +# programming language that uses go modules. > +# @DESCRIPTION: > +# This eclass provides some basic things needed by all software > +# written in the go programming language that uses go modules. > +# > +# You will know the software you are packaging uses modules because > +# it will have files named go.sum and go.mod in its top-level source > +# directory. If it does not have these files, use the golang-* eclasses. > +# > +# This eclass provides a src_unpack function which unpacks the=20 > +# first tarball mentioned in SRC_URI to the usual location and unpacks > +# any modules mentioned in EGO_VENDOR to ${S}/vendor if upstream doesn't > +# vendor its own dependencies. > +# > +# If upstream vendors its dependencies, setting EGO_VENDOR is an error. > +# > +# Please note that this eclass currently handles only tarballs > +# (.tar.gz), but support for more formats may be added in the future. > +# > +# Since Go programs are statically linked, it is important that your ebu= ild's > +# LICENSE=3D setting includes the licenses of all statically linked > +# dependencies. So please make sure it is accurate. > +# > +# @EXAMPLE: > +# > +# @CODE > +# EGO_VENDOR=3D( > +# "github.com/xenolf/lego 6cac0ea7d8b28c889f709ec7fa92e92b82f490dd" > +# "golang.org/x/crypto 453249f01cfeb54c3d549ddb75ff152ca243f9d8 github.c= om/golang/crypto" > +# ) > +# > +# inherit go-module > +# > +# SRC_URI=3D"https://github.com/example/${PN}/archive/v${PV}.tar.gz -> $= {P}.tar.gz > +# ${EGO_VENDOR_URI}" > +# @CODE > +# > +# The above example will extract the tarball to ${S} and > +# extract the contents of EGO_VENDOR to ${S}/vendor. > + > +case ${EAPI:-0} in > + 7) ;; > + *) die "${ECLASS} API in EAPI ${EAPI} not yet established." > +esac > + > +if [[ -z ${_GO_MODULE} ]]; then > + > +_GO_MODULE=3D1 > + > +BDEPEND=3D">=3Ddev-lang/go-1.12" > + > +# Force go to build in module mode. > +# In this mode the GOPATH environment variable is ignored. > +# this will become the default in the future. > +export GO111MODULE=3Don > + > +# The following go flags should be used for all builds. > +# -mod=3Dvendor stopps downloading of dependencies from the internet. > +# -v prints the names of packages as they are compiled > +# -x prints commands as they are executed > +export GOFLAGS=3D"-mod=3Dvendor -v -x" > + > +# Do not complain about CFLAGS etc since go projects do not use them. > +QA_FLAGS_IGNORED=3D'.*' > + > +# Go packages should not be stripped with strip(1). > +RESTRICT=3D"strip" > + > +EXPORT_FUNCTIONS src_unpack pkg_postinst > + > +# @ECLASS-VARIABLE: EGO_VENDOR > +# @DESCRIPTION: > +# This variable contains a list of vendored packages. > +# The items of this array are strings that contain the > +# import path and the git commit hash for a vendored package. > +# If the import path does not start with github.com, the third argument > +# can be used to point to a github repository. > + > +declare -arg EGO_VENDOR > + > +_go-module_set_vendor_uri() { > + EGO_VENDOR_URI=3D > + local lib > + for lib in "${EGO_VENDOR[@]}"; do > + lib=3D(${lib}) > + if [[ -n ${lib[2]} ]]; then > + EGO_VENDOR_URI+=3D" https://${lib[2]}/archive/${lib[1]}.tar.gz -> ${l= ib[2]//\//-}-${lib[1]}.tar.gz" > + else > + EGO_VENDOR_URI+=3D" https://${lib[0]}/archive/${lib[1]}.tar.gz -> ${l= ib[0]//\//-}-${lib[1]}.tar.gz" > + fi > + done > + readonly EGO_VENDOR_URI > +} > + > +_go-module_set_vendor_uri > +unset -f _go-module_set_vendor_uri > + > +_go-module_dovendor() { > + local VENDOR_PATH=3D$1 VENDORPN=3D$2 TARBALL=3D$3 > + rm -fr "${VENDOR_PATH}/${VENDORPN}" || die > + mkdir -p "${VENDOR_PATH}/${VENDORPN}" || die > + tar -C "${VENDOR_PATH}/${VENDORPN}" -x --strip-components 1\ > + -f "${DISTDIR}/${TARBALL}" || die > +} > + > +# @FUNCTION: go-module_src_unpack > +# @DESCRIPTION: > +# Extract the first archive from ${A} to ${S}, then extract > +# any sources mentioned in ${EGO_VENDOR} to ${S}/vendor. > +go-module_src_unpack() { > + local lib vendor_path x > + set -- ${A} > + x=3D"$1" > + mkdir -p "${S}" || die > + tar -C "${S}/" -x --strip-components 1 \ > + -f "${DISTDIR}/${x}" || die > + > + if [[ -n "${EGO_VENDOR}" ]]; then > + vendor_path=3D"${S}/vendor" > + if [[ -d "${vendor_path}" ]]; then > + eerror "Upstream for ${P}.ebuild vendors dependencies." > + die "Remove EGO_VENDOR from the ebuild." > + fi > + mkdir -p "${vendor_path}" || die > + for lib in "${EGO_VENDOR[@]}"; do > + lib=3D(${lib}) > + if [[ -n ${lib[2]} ]]; then > + einfo "Vendoring ${lib[0]} ${lib[2]//\//-}-${lib[1]}.tar.gz" > + _go-module_dovendor "${vendor_path}" ${lib[0]} \ > + ${lib[2]//\//-}-${lib[1]}.tar.gz > + else > + einfo "Vendoring ${lib[0]} ${lib[0]//\//-}-${lib[1]}.tar.gz" > + _go-module_dovendor "${vendor_path}" ${lib[0]} \ > + ${lib[0]//\//-}-${lib[1]}.tar.gz > + fi > + done > + fi > +} > + > +# @FUNCTION: go-module_pkg_postinst > +# @DESCRIPTION: > +# Display a warning about security updates for Go programs. > +go-module_pkg_postinst() { > + ewarn "${PN} is written in the Go programming language." > + ewarn "Since this language is statically linked, security" > + ewarn "updates will be handled in individual packages and will be" > + ewarn "difficult for us to track as a distribution." > + ewarn "For this reason, please update any go packages asap when new" > + ewarn "versions enter the tree or go stable if you are running the" > + ewarn "stable tree." I don't really understand why you're adding it to *this* eclass. Isn't it true for all Go packages? So I suppose golang-* eclasses are affected as well. > +} > + > +fi --=20 Best regards, Micha=C5=82 G=C3=B3rny --=-r1Qk0A4fsWHCUyy39M8d Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iQGTBAABCgB9FiEEx2qEUJQJjSjMiybFY5ra4jKeJA4FAl2Ck5lfFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldEM3 NkE4NDUwOTQwOThEMjhDQzhCMjZDNTYzOUFEQUUyMzI5RTI0MEUACgkQY5ra4jKe JA4L3Af9Hi5wvPo6WXFozjkJTd8BxZcRKdDvcDEzqkn1w6io0WAqC28qZqZTZIhW 1qOxLUvrofVYGpg9aCl6JSVDaJEc2liFIPOy1BN+q5Y85+SJkCrJ2uE/X1W3KlnG kKBI3LUWzQg6DCBzkWJxUArnOFLoWFf5PEpBsMSrvV7GGUIuHq0zTK/ARw4cdtoN ysoNW0SBE4ysikQ5ErXjEFqvia+w/uuoFd/+mL0Sv2zLNGA13lcc0gvQH4rxkL9G gv34l3oghNS5zSIyCzv44emFmg4aqQ2YsxVdKAEwv4ecIv9oQdg7RDPehuZnMqjh 3RTnjxYtcWpSHxGGvlU08EzkpMDEBA== =a9AT -----END PGP SIGNATURE----- --=-r1Qk0A4fsWHCUyy39M8d--