aboutsummaryrefslogtreecommitdiff
path: root/builder/builder2v1/build_file.go
blob: c7cc6bee200251975a638d0f06970a0fc18a74d1 (plain)
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
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

package builder2v1

import (
	"fmt"
	"path/filepath"

	"github.com/spdx/tools-golang/spdx"
	"github.com/spdx/tools-golang/utils"
)

// BuildFileSection2_1 creates an SPDX File (version 2.1), returning that
// file or error if any is encountered. Arguments:
//   - filePath: path to file, relative to prefix
//   - prefix: relative directory for filePath
//   - fileNumber: integer index (unique within package) to use in identifier
func BuildFileSection2_1(filePath string, prefix string, fileNumber int) (*spdx.File2_1, error) {
	// build the full file path
	p := filepath.Join(prefix, filePath)

	// make sure we can get the file and its hashes
	ssha1, ssha256, smd5, err := utils.GetHashesForFilePath(p)
	if err != nil {
		return nil, err
	}

	// build the identifier
	i := fmt.Sprintf("SPDXRef-File%d", fileNumber)

	// now build the File section
	f := &spdx.File2_1{
		FileName:           filePath,
		FileSPDXIdentifier: i,
		FileChecksumSHA1:   ssha1,
		FileChecksumSHA256: ssha256,
		FileChecksumMD5:    smd5,
		LicenseConcluded:   "NOASSERTION",
		LicenseInfoInFile:  []string{},
		FileCopyrightText:  "NOASSERTION",
	}

	return f, nil
}