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 EA8E5138334 for ; Thu, 12 Sep 2019 16:40:01 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id B13CFE095A; Thu, 12 Sep 2019 16:39:58 +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 4CB60E08FB for ; Thu, 12 Sep 2019 16:39:58 +0000 (UTC) Received: from whubbs1.gaikai.biz (unknown [100.42.103.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: williamh) by smtp.gentoo.org (Postfix) with ESMTPSA id 2ED4A34B037; Thu, 12 Sep 2019 16:39:57 +0000 (UTC) Received: (nullmailer pid 24154 invoked by uid 1000); Thu, 12 Sep 2019 16:39:54 -0000 Date: Thu, 12 Sep 2019 11:39:54 -0500 From: William Hubbs To: gentoo-dev@lists.gentoo.org Cc: mgorny@gentoo.org Subject: Re: [gentoo-dev] [PATCH 1/3] go-module.eclass: introduce new eclass to handle go modules Message-ID: <20190912163954.GA24121@whubbs1.dev.av1.gaikai.org> Mail-Followup-To: gentoo-dev@lists.gentoo.org, mgorny@gentoo.org References: <20190911172128.18885-1-williamh@gentoo.org> <20190911172128.18885-2-williamh@gentoo.org> <1839d49b6adcfeba3c807543e0ba01e0f2888a36.camel@gentoo.org> <20190911182238.GA19361@whubbs1.dev.av1.gaikai.org> <20190911194041.GA19620@whubbs1.dev.av1.gaikai.org> <20190911231115.GA20687@whubbs1.dev.av1.gaikai.org> <06381929-4520-4284-B868-EB83D5AE3D6B@gentoo.org> 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 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="ReaqsoxgOBHFXBhH" Content-Disposition: inline In-Reply-To: <06381929-4520-4284-B868-EB83D5AE3D6B@gentoo.org> User-Agent: Mutt/1.10.1 (2018-07-13) X-Archives-Salt: 57cda894-0b98-4d0c-9fb3-ba32d771fdda X-Archives-Hash: 7f146047d7c7bdfc204f3b9cd061251f --ReaqsoxgOBHFXBhH Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Sep 12, 2019 at 05:39:42AM +0000, Micha=C5=82 G=C3=B3rny wrote: > Dnia September 11, 2019 11:11:15 PM UTC, William Hubbs napisa=C5=82(a): > >On Wed, Sep 11, 2019 at 07:47:04PM +0000, Micha=C5=82 G=C3=B3rny wrote: > >> Dnia September 11, 2019 7:40:41 PM UTC, William Hubbs > > napisa=C5=82(a): > >> >On Wed, Sep 11, 2019 at 08:31:16PM +0200, Micha=C5=82 G=C3=B3rny wrot= e: > >> >> On Wed, 2019-09-11 at 13:22 -0500, William Hubbs wrote: > >> >> > On Wed, Sep 11, 2019 at 07:38:17PM +0200, Micha=C5=82 G=C3=B3rny = wrote: > >> >> > > On Wed, 2019-09-11 at 12:21 -0500, William Hubbs wrote: > >> >> > > > Copyright: Sony Interactive Entertainment Inc. > >> >> > > > Signed-off-by: William Hubbs > >> >> > > > --- > >> >> > > > eclass/go-module.eclass | 76 > >> >+++++++++++++++++++++++++++++++++++++++++ > >> >> > > > 1 file changed, 76 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..7009fcd3beb > >> >> > > > --- /dev/null > >> >> > > > +++ b/eclass/go-module.eclass > >> >> > > > @@ -0,0 +1,76 @@ > >> >> > > > +# Copyright 1999-2015 Gentoo Foundation > >> >> > >=20 > >> >> > > You need to replace your calendar. And copyright holder. > >> >> >=20 > >> >> > Sure, I thought I ffixed that. > >> >> >=20 > >> >> > > > +# Distributed under the terms of the GNU General Public > >> >License v2 > >> >> > > > + > >> >> > > > +# @ECLASS: go-module.eclass > >> >> > >=20 > >> >> > > Any reason to change naming from golang-* to go-* now? > >> >> >=20 > >> >> > Well, "lang" is sort of redundant, and there will be only one > >> >eclass, so > >> >> > I thought I would make things a bit more simple. > >> >> >=20 > >> >> > > > +# @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 a convenience src_prepare() phase > >and > >> >some basic > >> >> > > > +# settings needed for 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. > >> >> > > > +# > >> >> > > > +# If the software you are packaging uses modules, the next > >> >question is > >> >> > > > +# whether it has a directory named "vendor" at the > >top-level > >> >of the source tree. > >> >> > > > +# > >> >> > > > +# If it doesn't, you need to create a tarball of what would > >be > >> >in the > >> >> > > > +# vendor directory and mirror it locally. This is done with > >> >the > >> >> > > > +# following commands if upstream is using a git repository: > >> >> > > > +# > >> >> > > > +# @CODE: > >> >> > > > +# > >> >> > > > +# $ cd /my/clone/of/upstream > >> >> > > > +# $ git checkout > >> >> > > > +# $ go mod vendor > >> >> > > > +# $ tar cvf project-version-vendor.tar.gz vendor > >> >> > > > +# > >> >> > > > +# @CODE: > >> >> > > > +# > >> >> > > > +# Other than this, all you need to do is inherit this > >eclass > >> >then > >> >> > > > +# make sure the exported src_prepare function is run. > >> >> > > > + > >> >> > > > +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" > >> >> > > > + > >> >> > > > +# Do not download dependencies from the internet > >> >> > > > +# make build output verbose by default > >> >> > > > +export GOFLAGS=3D"-mod=3Dvendor -v -x" > >> >> > > > + > >> >> > > > +# Do not complain about CFLAGS etc since go projects do not > >> >use them. > >> >> > > > +QA_FLAGS_IGNORED=3D'.*' > >> >> > > > + > >> >> > > > +# Upstream does not support stripping go packages > >> >> > > > +RESTRICT=3D"strip" > >> >> > > > + > >> >> > > > +EXPORT_FUNCTIONS src_prepare > >> >> > >=20 > >> >> > > Don't you need to inherit some other eclass to make it build? > >> >> >=20 > >> >> > The primary reason for all of the golang-* eclasses was the > >GOPATH > >> >> > variable, which is not relevant when you are using modules. > >> >> >=20 > >> >> > I can look at adding a src_compile to this eclass, but I haven't > >> >thought > >> >> > about what it would contain yet. > >> >> > =20 > >> >> > > > + > >> >> > > > +# @FUNCTION: go-module_src_prepare > >> >> > > > +# @DESCRIPTION: > >> >> > > > +# Run a default src_prepare then move our provided vendor > >> >directory to > >> >> > > > +# the appropriate spot if upstream doesn't provide a vendor > >> >directory. > >> >> > > > +go-module_src_prepare() { > >> >> > > > + default > >> >> > > > + # Use the upstream provided vendor directory if it exists. > >> >> > > > + [[ -d vendor ]] && return > >> >> > > > + # If we are not providing a mirror of a vendor directory > >we > >> >created > >> >> > > > + # manually, return since there may be nothing to vendor. > >> >> > > > + [[ ! -d ../vendor ]] && return > >> >> > > > + # At this point, we know we are providing a vendor mirror. > >> >> > > > + mv ../vendor . || die "Unable to move ../vendor directory" > >> >> > >=20 > >> >> > > Wouldn't it be much simpler to create appropriate directory > >> >structure > >> >> > > in the tarball? Then you wouldn't need a new eclass at all. > >> >> >=20 > >> >> > You would definitely need an eclass (see the settings and > >> >dependencies). > >> >> >=20 > >> >> > Take a look at the differences in the spire and hub ebuilds in > >this > >> >> > series. I'm not sure what you mean by adding the directory > >> >structure to > >> >> > the tarball? I guess you could add something to the vendor > >tarball > >> >when > >> >> > you create it. > >> >>=20 > >> >> I mean packing it as 'spire-1.2.3/vendor' or whatever the package > >> >> directory is, so that it extracts correctly instead of making a > >> >tarball > >> >> that needs to be moved afterwards. > >> > > >> >That would clobber the upstream provided vendor directory and that's > >> >what I want to avoid with the first test in src_prepare. > >>=20 > >> If upstream already includes vendored modules, why would you create > >your own tarball in the first place? > >=20 > >You are right, and currently I quietly ignore your vendor tarball if > >upstream > >vendors the dependencies also. I could change this to generate a > >warning > >or die and force you to fix the ebuild, but that would not be possible > >if I follow your suggestion because I would not be able to tell whether > >the vendored dependencies came from us or upstream. >=20 > Why would anyone create a vendor tarball if things work without it? That = makes no sense. Also adding unused archives to SRC_URI is a QA violation. All the more reason to not have the vendor tarball overwrite the vendor directory upstream. I will show you when I update the eclass. >=20 > > > >Also, another concern about your suggestion is the --transform switch > >that would have to be added to the tar command people use to create > >the > >vendor tarball, something like: > > > >tar -acvf package-version-vendor.tar.gz > >--transform=3D's#^vendor#package-version-vendor#' vendor > > > >You suggested that a maintainer could create a new tarball and build on > >top of it. I guess you mean don't use upstream's tarball if they don't > >vendor and create my own tarball and add the vendor directory to it. > >I'm > >against that option because I don't feel that we should manually > >tinker > >with upstream tarballs. That opens a pretty big can of worms imo. >=20 > No. I suggested that rather than adding another git clone and checking ou= t a tag (which sooner or later would mean someone forgetting and using mast= er instead), you could unpack the same archive you're going to use in the e= build. Ok, I am really not following you, so let's talk about this in the context of an example. Look at app-misc/spire and tell me how you would do it differently. William --ReaqsoxgOBHFXBhH Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature -----BEGIN PGP SIGNATURE----- iF0EARECAB0WIQTVeuxEZo4uUHOkQAluVBb0MMRlOAUCXXp01AAKCRBuVBb0MMRl OLgiAKCAd94M2vUrDONAJBhIVNcC9aQVlACgnH/Mt/4a5gXafEkU0KeT18T5LrA= =ygyv -----END PGP SIGNATURE----- --ReaqsoxgOBHFXBhH--