1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2017 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package osutil_test
import (
"encoding/hex"
"os"
"os/exec"
"path/filepath"
"regexp"
. "gopkg.in/check.v1"
"github.com/snapcore/snapd/osutil"
"github.com/snapcore/snapd/testutil"
)
type buildIDSuite struct {
testutil.BaseTest
}
var _ = Suite(&buildIDSuite{})
var truePath = osutil.LookPathDefault("true", "/bin/true")
var falsePath = osutil.LookPathDefault("false", "/bin/false")
var gccPath = osutil.LookPathDefault("gcc", "/usr/bin/gcc")
func (s *buildIDSuite) SetUpTest(c *C) {
s.BaseTest.SetUpTest(c)
}
func buildID(c *C, fname string) string {
// XXX Host's "file" command may be too old to know about Go BuildID or
// hexstring GNU BuildID, use with caution. Use "-L" to follow symlinks,
// to also cover e.g. Ubuntu 25.10 where /bin/true is a symlink to gnutrue.
output, err := exec.Command("file", "-L", fname).CombinedOutput()
c.Assert(err, IsNil)
c.Logf("file output: %q", string(output))
// BuildID can look like:
// BuildID[sha1]=443877f9ec13c82365478130fc95cb5ff5181912
// BuildID[md5/uuid]=ae38cdf243d2111064dfee99dfc30013
// Go BuildID=YDAw4RLIEKpyxl90JbFQ/s9mld--03zAIIQ1tGb_5/aL-yPp ...
re := regexp.MustCompile(`BuildID(\[.*\]|)=([a-zA-Z0-9/_-]+)`)
matches := re.FindStringSubmatch(string(output))
c.Assert(matches, HasLen, 3)
return matches[2]
}
func (s *buildIDSuite) TestReadBuildID(c *C) {
for _, fname := range []string{truePath, falsePath} {
id, err := osutil.ReadBuildID(fname)
c.Assert(err, IsNil)
c.Assert(id, Equals, buildID(c, fname), Commentf("executable: %s", fname))
}
}
func (s *buildIDSuite) TestReadBuildIDNoID(c *C) {
stripedTruth := filepath.Join(c.MkDir(), "true")
osutil.CopyFile(truePath, stripedTruth, 0)
output, err := exec.Command("strip", "-R", ".note.gnu.build-id", stripedTruth).CombinedOutput()
c.Assert(string(output), Equals, "")
c.Assert(err, IsNil)
id, err := osutil.ReadBuildID(stripedTruth)
c.Assert(err, Equals, osutil.ErrNoBuildID)
c.Assert(id, Equals, "")
}
func (s *buildIDSuite) TestReadBuildIDmd5(c *C) {
if !osutil.FileExists(gccPath) {
c.Skip("No gcc found")
}
md5Truth := filepath.Join(c.MkDir(), "true")
err := os.WriteFile(md5Truth+".c", []byte(`int main(){return 0;}`), 0644)
c.Assert(err, IsNil)
output, err := exec.Command(gccPath, "-Wl,--build-id=md5", "-xc", md5Truth+".c", "-o", md5Truth).CombinedOutput()
c.Assert(string(output), Equals, "")
c.Assert(err, IsNil)
id, err := osutil.ReadBuildID(md5Truth)
c.Assert(err, IsNil)
c.Assert(id, Equals, buildID(c, md5Truth))
}
func (s *buildIDSuite) TestReadBuildIDFixedELF(c *C) {
if !osutil.FileExists(gccPath) {
c.Skip("No gcc found")
}
md5Truth := filepath.Join(c.MkDir(), "true")
err := os.WriteFile(md5Truth+".c", []byte(`int main(){return 0;}`), 0644)
c.Assert(err, IsNil)
output, err := exec.Command(gccPath, "-Wl,--build-id=0xdeadcafe", "-xc", md5Truth+".c", "-o", md5Truth).CombinedOutput()
c.Assert(string(output), Equals, "")
c.Assert(err, IsNil)
id, err := osutil.ReadBuildID(md5Truth)
c.Assert(err, IsNil)
// XXX cannot call buildID() as the host's 'file' command may be too old
// to know about hexstring format of GNU BuildID
c.Assert(id, Equals, "deadcafe")
}
func (s *buildIDSuite) TestMyBuildID(c *C) {
restore := osutil.MockOsReadlink(func(string) (string, error) {
return truePath, nil
})
defer restore()
id, err := osutil.MyBuildID()
c.Assert(err, IsNil)
c.Check(id, Equals, buildID(c, truePath))
}
func (s *buildIDSuite) TestReadBuildGo(c *C) {
if os.Getenv("DH_GOPKG") != "" {
// Failure reason is unknown but only reproducible
// inside the any 21.04+ sbuild/pbuilder build
// environment during the build (with dh-golang).
//
// Not reproducible outside of dpkg-buildpackage.
c.Skip("This `go build` fails inside the dpkg-buildpackage environment with `loadinternal: cannot find runtime/cgo`")
}
tmpdir := c.MkDir()
goTruth := filepath.Join(tmpdir, "true")
err := os.WriteFile(goTruth+".go", []byte(`package main; func main(){}`), 0644)
c.Assert(err, IsNil)
// force specific Go BuildID
//
// XXX: note, Go toolchain, specifically 1.24+ started adding GNU BuildID by
// default which the code tries to read first
cmd := exec.Command("go", "build", "-o", goTruth, "-ldflags=-buildid=foobar", goTruth+".go")
// set custom homedir to ensure tests work in an sbuild environment
// that force a non-existing homedir
cmd.Env = append(os.Environ(), "HOME="+tmpdir)
cmd.Dir = tmpdir
output, err := cmd.CombinedOutput()
c.Assert(string(output), Equals, "")
c.Assert(err, IsNil)
id, err := osutil.ReadGoBuildID(goTruth)
c.Assert(err, IsNil)
// ReadBuildID returns a hex encoded string, however buildID()
// returns the "raw" string so we need to decode first
decoded, err := hex.DecodeString(id)
c.Assert(err, IsNil)
// XXX cannot call buildID() as the host's 'file' command may be too old
// to know about Go BuildID
c.Assert(string(decoded), Equals, "foobar")
}
|