-
Notifications
You must be signed in to change notification settings - Fork 82
/
apkbuild.go
511 lines (435 loc) · 15.8 KB
/
apkbuild.go
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
package apkbuild
import (
"context"
"crypto/sha256"
"crypto/sha512"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"time"
rlhttp "chainguard.dev/melange/pkg/http"
"chainguard.dev/melange/pkg/manifest"
"github.com/chainguard-dev/clog"
apkotypes "chainguard.dev/apko/pkg/build/types"
"chainguard.dev/melange/pkg/config"
"chainguard.dev/melange/pkg/convert/wolfios"
"chainguard.dev/melange/pkg/util"
"gitlab.alpinelinux.org/alpine/go/apkbuild"
"golang.org/x/exp/slices"
"golang.org/x/time/rate"
"gopkg.in/yaml.v3"
)
type Context struct {
*NavigationMap
OutDir string
AdditionalRepositories []string
AdditionalKeyrings []string
ExcludePackages []string
Client *rlhttp.RLHTTPClient
WolfiOSPackages map[string]bool
}
type NavigationMap struct {
ApkConvertors map[string]ApkConvertor
OrderedKeys []string
}
type Dependency struct {
Name string
}
type ApkConvertor struct {
*apkbuild.Apkbuild
ApkBuildRaw []byte
*manifest.GeneratedMelangeConfig `yaml:"-"`
}
// New initialise including a map of existing wolfios packages
func New(ctx context.Context) (Context, error) {
context := Context{
NavigationMap: &NavigationMap{
ApkConvertors: map[string]ApkConvertor{},
OrderedKeys: []string{},
},
Client: &rlhttp.RLHTTPClient{
Client: http.DefaultClient,
// 1 request every second to avoid DOS'ing server
Ratelimiter: rate.NewLimiter(rate.Every(1*time.Second), 1),
},
}
var err error
wolfi := wolfios.New(http.DefaultClient, wolfios.PackageIndex)
context.WolfiOSPackages, err = wolfi.GetWolfiPackages(ctx)
if err != nil {
return context, fmt.Errorf("failed to get packages from wolfi index: %w", err)
}
return context, nil
}
func (c Context) Generate(ctx context.Context, apkBuildURI, pkgName string) error {
log := clog.FromContext(ctx)
// get the contents of the APKBUILD file
err := c.getApkBuildFile(ctx, apkBuildURI, pkgName)
if err != nil {
return fmt.Errorf("getting apk build file: %w", err)
}
// build map of dependencies
err = c.buildMapOfDependencies(ctx, apkBuildURI, pkgName)
if err != nil {
return fmt.Errorf("building map of dependencies: %w", err)
}
// reverse map order, so we generate the lowest transitive dependency first
// this will help to build convert configs in the correct order
util.ReverseSlice(c.OrderedKeys)
// loop over map and generate convert config for each
for i, key := range c.OrderedKeys {
apkConverter := c.ApkConvertors[key]
// automatically add a fetch step to the convert config to fetch the source
err = c.buildFetchStep(ctx, apkConverter)
if err != nil {
// lets not error if we can't automatically add the fetch step
log.Infof("skipping fetch step for %s", err.Error())
}
// maps the APKBUILD values to convert config
apkConverter.mapconvert()
// builds the convert environment configuration
apkConverter.buildEnvironment(c.AdditionalRepositories, c.AdditionalKeyrings)
err = apkConverter.write(ctx, strconv.Itoa(i), c.OutDir)
if err != nil {
return fmt.Errorf("writing convert config file: %w", err)
}
}
return nil
}
func (c Context) getApkBuildFile(ctx context.Context, apkbuildURL, packageName string) error {
req, _ := http.NewRequestWithContext(ctx, "GET", apkbuildURL, nil)
resp, err := c.Client.Do(req)
if err != nil {
return fmt.Errorf("getting %s: %w", apkbuildURL, err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("non ok http response code: %v", resp.StatusCode)
}
apkbuildFile := apkbuild.NewApkbuildFile(packageName, resp.Body)
parsedApkBuild, err := apkbuild.Parse(apkbuildFile, nil)
if err != nil {
return fmt.Errorf("failed to parse apkbuild %s: %w", apkbuildURL, err)
}
c.ApkConvertors[packageName] = ApkConvertor{
Apkbuild: &parsedApkBuild,
GeneratedMelangeConfig: &manifest.GeneratedMelangeConfig{
GeneratedFromComment: apkbuildURL,
},
}
c.ApkConvertors[packageName].GeneratedMelangeConfig.Package = config.Package{
Epoch: 0,
}
c.OrderedKeys = append(c.OrderedKeys, packageName)
return nil
}
// recursively add dependencies, and their dependencies to our map
func (c Context) buildMapOfDependencies(ctx context.Context, apkBuildURI, pkgName string) error {
log := clog.FromContext(ctx)
convertor, exists := c.ApkConvertors[pkgName]
if !exists {
return fmt.Errorf("no top level apk convertor found for URI %s", apkBuildURI)
}
dependencies := c.transitiveDependencyList(convertor)
// recursively loop round and add any missing dependencies to the map
for _, dep := range dependencies {
if strings.TrimSpace(dep) == "" {
continue
}
// remove -dev or -static from dependency name when looking up matching APKBUILD
dep = strings.TrimSuffix(dep, "-dev")
dep = strings.TrimSuffix(dep, "-static")
// skip if we already have a package in wolfi-os repository
log.Infof("checking if %s is all ready in wolfi os", dep)
if c.WolfiOSPackages[dep] {
log.Infof("yes it is, skipping...")
continue
}
// if dependency is in the list of packages configured one the CLI to exclude, let's skip
log.Infof("checking if %s is in %s", dep, strings.Join(c.ExcludePackages, " "))
if contains(c.ExcludePackages, dep) {
log.Infof("yes it is, skipping...")
continue
}
// using the same base URI switch the existing package name for the dependency and get related APKBUILD
dependencyApkBuildURI := strings.ReplaceAll(apkBuildURI, convertor.Apkbuild.Pkgname, dep)
// if we don't already have this dependency in the map, go get it
_, exists = c.ApkConvertors[dep]
if exists {
// move dependency to the end of our ordered keys to ensure we generate melange configs in the correct order
// TODO lets switch this to use https://github.com/wolfi-dev/dag
var reorderdKeys []string
for _, key := range c.OrderedKeys {
if key != dep {
reorderdKeys = append(reorderdKeys, key)
}
}
reorderdKeys = append(reorderdKeys, dep)
c.OrderedKeys = reorderdKeys
} else {
// if the dependency doesn't already exist let's go and get it
err := c.getApkBuildFile(ctx, dependencyApkBuildURI, dep)
if err != nil {
// log and skip this dependency if there's an issue getting the APKBUILD as we are guessing the location of the APKBUILD
log.Infof("failed to get APKBUILD %s", dependencyApkBuildURI)
continue
}
err = c.buildMapOfDependencies(ctx, dependencyApkBuildURI, dep)
if err != nil {
return fmt.Errorf("building map of dependencies: %w", err)
}
}
}
return nil
}
func (c Context) transitiveDependencyList(convertor ApkConvertor) []string {
var dependencies []string
for _, depends := range convertor.Apkbuild.Depends {
if !util.Contains(dependencies, depends.Pkgname) {
dependencies = append(dependencies, depends.Pkgname)
}
}
for _, depends := range convertor.Apkbuild.Makedepends {
if !util.Contains(dependencies, depends.Pkgname) {
dependencies = append(dependencies, depends.Pkgname)
}
}
for _, depends := range convertor.Apkbuild.DependsDev {
if !util.Contains(dependencies, depends.Pkgname) {
dependencies = append(dependencies, depends.Pkgname)
}
}
return dependencies
}
// add pipeline fetch steps, validate checksums and generate mconvert expected sha
func (c Context) buildFetchStep(ctx context.Context, converter ApkConvertor) error {
log := clog.FromContext(ctx)
apkBuild := converter.Apkbuild
if len(apkBuild.Source) == 0 {
log.Infof("skip adding pipeline for package %s, no source URL found", converter.Pkgname)
return nil
}
if apkBuild.Pkgver == "" {
return fmt.Errorf("no package version")
}
// there can be multiple sources, let's add them all so, it's easier for users to remove from generated files if not needed
for _, source := range apkBuild.Source {
location := source.Location
_, err := url.ParseRequestURI(location)
if err != nil {
return fmt.Errorf("parsing URI %s: %w", location, err)
}
req, _ := http.NewRequestWithContext(ctx, "GET", location, nil)
resp, err := c.Client.Do(req)
if err != nil {
return fmt.Errorf("failed getting URI %s: %w", location, err)
}
defer resp.Body.Close()
failed := false
if resp.StatusCode != http.StatusOK {
log.Infof("non ok http response for URI %s code: %v", location, resp.StatusCode)
failed = true
}
b, err := io.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("failed getting URI %s: %w", location, err)
}
var expectedSha string
if !failed {
// validate the source we are using matches the correct sha512 in the APKBIULD
validated := false
for _, shas := range apkBuild.Sha512sums {
if shas.Source == source.Filename {
h512 := sha512.New()
h512.Write(b)
if shas.Hash == fmt.Sprintf("%x", h512.Sum(nil)) {
validated = true
}
}
}
// now generate the 256 sha we need for a mconvert config
if !validated {
expectedSha = "SHA512 DOES NOT MATCH SOURCE - VALIDATE MANUALLY"
log.Infof("source %s expected sha512 do not match!", source.Filename)
} else {
h256 := sha256.New()
h256.Write(b)
expectedSha = fmt.Sprintf("%x", h256.Sum(nil))
}
} else {
expectedSha = "FIXME - SOURCE URL NOT VALID"
}
pipeline := config.Pipeline{
Uses: "fetch",
With: map[string]string{
"uri": strings.ReplaceAll(location, apkBuild.Pkgver, "${{package.version}}"),
"expected-sha256": expectedSha,
},
}
converter.GeneratedMelangeConfig.Pipeline = append(converter.GeneratedMelangeConfig.Pipeline, pipeline)
}
return nil
}
// maps APKBUILD values to mconvert
func (c ApkConvertor) mapconvert() {
c.GeneratedMelangeConfig.Package.Name = c.Apkbuild.Pkgname
c.GeneratedMelangeConfig.Package.Description = c.Apkbuild.Pkgdesc
c.GeneratedMelangeConfig.Package.Version = c.Apkbuild.Pkgver
c.GeneratedMelangeConfig.Package.Epoch = 0
copyright := config.Copyright{
License: c.Apkbuild.License,
}
c.GeneratedMelangeConfig.Package.Copyright = append(c.GeneratedMelangeConfig.Package.Copyright, copyright)
// triggers
if c.Apkbuild.Triggers != nil {
c.GeneratedMelangeConfig.Package.Scriptlets.Trigger.Paths = []string{"FIXME"}
c.GeneratedMelangeConfig.Package.Scriptlets.Trigger.Script = "FIXME"
}
// if c.Apkbuild.Funcs["build"] != nil {
// // todo lets check the command and add the correct cmake | make | meson mconvert pipelines
// //build := c.Apkbuild.Funcs["build"]
//}
// switch c.Apkbuild.BuilderType {
//
// case BuilderTypeCMake:
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "cmake/configure"})
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "cmake/build"})
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "cmake/install"})
//
// case BuilderTypeMeson:
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "meson/configure"})
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "meson/compile"})
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "meson/install"})
//
// case BuilderTypeMake:
c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "autoconf/configure"})
c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "autoconf/make"})
c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "autoconf/make-install"})
c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "strip"})
//default:
// c.GeneratedMelangeConfig.Pipeline = append(c.GeneratedMelangeConfig.Pipeline, config.Pipeline{Uses: "# FIXME"})
//
//}
for _, subPackage := range c.Apkbuild.Subpackages {
subpackage := config.Subpackage{
Name: strings.Replace(subPackage.Subpkgname, "$pkgname", c.Apkbuild.Pkgname, 1),
}
// generate subpackages based on the subpackages defined in the APKBUILD
var ext string
// parts := strings.Split(subPackage.Subpkgname, "-")
i := strings.LastIndex(subPackage.Subpkgname, "-")
if i > 0 {
suffix := subPackage.Subpkgname[i+1:]
switch suffix {
case "doc":
ext = "manpages"
case "static":
ext = "static"
case "dev":
ext = "dev"
subpackage.Dependencies = config.Dependencies{
Runtime: []string{c.Apkbuild.Pkgname},
}
// include dev dependencies in the dev runtime
for _, dependsDev := range c.Apkbuild.DependsDev {
subpackage.Dependencies.Runtime = append(subpackage.Dependencies.Runtime, dependsDev.Pkgname)
}
for _, depends := range c.Apkbuild.Depends {
subpackage.Dependencies.Runtime = append(subpackage.Dependencies.Runtime, depends.Pkgname)
}
default:
// if we don't recognise the extension make it obvious user needs to manually fix the config
ext = "FIXME"
}
subpackage.Pipeline = []config.Pipeline{{Uses: "split/" + ext}}
subpackage.Description = c.Apkbuild.Pkgname + " " + ext
} else {
// if we don't recognise the extension make it obvious user needs to manually fix the mconvert config
subpackage.Pipeline = []config.Pipeline{{Runs: "FIXME"}}
}
c.GeneratedMelangeConfig.Subpackages = append(c.GeneratedMelangeConfig.Subpackages, subpackage)
}
}
// adds a mconvert environment section
func (c ApkConvertor) buildEnvironment(additionalRepositories, additionalKeyrings []string) {
// wolfi-os base environment
env := apkotypes.ImageConfiguration{
Contents: apkotypes.ImageContents{
Packages: []string{
"autoconf",
"automake",
"build-base",
"busybox",
"ca-certificates-bundle",
},
},
}
env.Contents.Repositories = append(env.Contents.Repositories, additionalRepositories...)
env.Contents.Keyring = append(env.Contents.Keyring, additionalKeyrings...)
for _, makedepend := range c.Apkbuild.Makedepends {
env.Contents.Packages = append(env.Contents.Packages, makedepend.Pkgname)
}
for _, dependsDev := range c.Apkbuild.DependsDev {
d := dependsDev.Pkgname
if !strings.HasSuffix(d, "-dev") {
d += "-dev"
}
if !contains(env.Contents.Packages, d) {
env.Contents.Packages = append(env.Contents.Packages, d)
}
}
for _, depends := range c.Apkbuild.Depends {
if !contains(env.Contents.Packages, depends.Pkgname) {
env.Contents.Packages = append(env.Contents.Packages, depends.Pkgname)
}
}
for i, p := range env.Contents.Packages {
if p == "$depends_dev" {
env.Contents.Packages = slices.Delete(env.Contents.Packages, i, i+1)
break
}
}
c.GeneratedMelangeConfig.Environment = env
}
func contains(s []string, str string) bool {
for _, v := range s {
if v == str {
return true
}
}
return false
}
func (c ApkConvertor) write(ctx context.Context, orderNumber, outdir string) error {
actual, err := yaml.Marshal(&c.GeneratedMelangeConfig)
if err != nil {
return fmt.Errorf("marshalling mconvert configuration: %w", err)
}
if _, err := os.Stat(outdir); os.IsNotExist(err) {
err = os.MkdirAll(outdir, os.ModePerm)
if err != nil {
return fmt.Errorf("creating output directory %s: %w", outdir, err)
}
}
// write the mconvert config, prefix with our guessed order along with zero to help users easily rename / reorder generated files
mconvertFile := filepath.Join(outdir, orderNumber+"0-"+c.Apkbuild.Pkgname+".yaml")
f, err := os.Create(mconvertFile)
if err != nil {
return fmt.Errorf("creating file %s: %w", mconvertFile, err)
}
defer f.Close()
_, err = f.WriteString(fmt.Sprintf("# Generated from %s\n", c.GeneratedMelangeConfig.GeneratedFromComment))
if err != nil {
return fmt.Errorf("creating writing to file %s: %w", mconvertFile, err)
}
_, err = f.WriteString(string(actual))
if err != nil {
return fmt.Errorf("creating writing to file %s: %w", mconvertFile, err)
}
clog.FromContext(ctx).Infof("Generated melange config: %s", mconvertFile)
return nil
}