aboutsummaryrefslogtreecommitdiff
path: root/examples/6-licensediff/example_licensediff.go
blob: 3a7b401ab7fc3dce13636823db8d9ec5796585bb (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
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
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

// Example for: *licensediff*, *tvloader*

// This example demonstrates loading two SPDX tag-value files from disk into
// memory, and generating a diff of the concluded licenses for Files in the
// first-listed Packages in each document.
// This is generally only useful when run with two SPDX documents that
// describe licenses for subsequent versions of the same set of files.

package main

import (
	"fmt"
	"os"

	"github.com/spdx/tools-golang/licensediff"
	"github.com/spdx/tools-golang/tvloader"
)

func main() {

	// check that we've received the right number of arguments
	args := os.Args
	if len(args) != 3 {
		fmt.Printf("Usage: %v <spdx-file-first> <spdx-file-second>\n", args[0])
		fmt.Printf("  Load SPDX 2.1 tag-value files <spdx-file-first> and <spdx-file-second>,\n")
		fmt.Printf("  run a diff between their concluded licenses, and print basic results.\n")
		return
	}

	// open the first SPDX file
	filenameFirst := args[1]
	r, err := os.Open(filenameFirst)
	if err != nil {
		fmt.Printf("Error while opening %v for reading: %v", filenameFirst, err)
		return
	}
	defer r.Close()

	// try to load the first SPDX file's contents as a tag-value file, version 2.1
	docFirst, err := tvloader.Load2_1(r)
	if err != nil {
		fmt.Printf("Error while parsing %v: %v", filenameFirst, err)
		return
	}
	// make sure it has at least one Package
	if len(docFirst.Packages) < 1 {
		fmt.Printf("Error, no packages found in SPDX file %s\n", filenameFirst)
		return
	}

	// if we got here, the file is now loaded into memory.
	fmt.Printf("Successfully loaded first SPDX file %s\n", filenameFirst)

	// open the second SPDX file
	filenameSecond := args[2]
	r, err = os.Open(filenameSecond)
	if err != nil {
		fmt.Printf("Error while opening %v for reading: %v", filenameSecond, err)
		return
	}
	defer r.Close()

	// try to load the second SPDX file's contents as a tag-value file, version 2.1
	docSecond, err := tvloader.Load2_1(r)
	if err != nil {
		fmt.Printf("Error while parsing %v: %v", filenameSecond, err)
		return
	}
	// make sure it has at least one Package
	if len(docSecond.Packages) < 1 {
		fmt.Printf("Error, no packages found in SPDX file %s\n", filenameSecond)
		return
	}

	// if we got here, the file is now loaded into memory.
	fmt.Printf("Successfully loaded second SPDX file %s\n\n", filenameSecond)

	// extract the first-listed package from each Document.
	// (there could be more than one Package within a Document. For
	// purposes of this example, we'll just look at the first one.)
	// we've already confirmed above that each has at least one Package.
	p1 := docFirst.Packages[0]
	p2 := docSecond.Packages[0]

	// now, run a diff between the two
	pairs, err := licensediff.MakePairs(p1, p2)
	if err != nil {
		fmt.Printf("Error generating licensediff pairs: %v\n", err)
		return
	}

	// take the pairs and turn them into a more structured results set
	resultSet, err := licensediff.MakeResults(pairs)
	if err != nil {
		fmt.Printf("Error generating licensediff results set: %v\n", err)
		return
	}

	// print some information about the results
	fmt.Printf("Files in first only: %d\n", len(resultSet.InFirstOnly))
	fmt.Printf("Files in second only: %d\n", len(resultSet.InSecondOnly))
	fmt.Printf("Files in both with different licenses: %d\n", len(resultSet.InBothChanged))
	fmt.Printf("Files in both with same licenses: %d\n", len(resultSet.InBothSame))
}