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
|
* Test input
** Structure
New test cases for [[file:scan-copyright.t][scan_copyright.t]] are in 2 forms:
- a =*.d= directory containing source files
- a =*.in= file containing the output of =licensecheck= command
** Creating a *.d directory
You must use a =*.d= directory if the test case requires copyright
scanner to extract data from source file. This is currently the case
for Rust, NodeJS, Perl and Raku modules.
This directory must contain at least the file containing copyright data:
| Language | file |
|----------+--------------|
| NodeJS | package.json |
| Perl | META.json |
| Raku | META6.json |
| Rust | Cargo.toml |
Then you can other source files to test copyright extracted from files using
=licensecheck=
** Creating a *.in file
Say you want to create a =foo_test.in= file using data from package
=foo=.
You have to run a set of commands like:
#+BEGIN_EXAMPLE
# create .in file
# in libconfig-model-dpkg-perl repo
export TEST=foo_test
export repo_dir=$PWD
cd path_to_foo
licensecheck --encoding utf8 --copyright --machine --shortname-scheme=debian,spdx --recursive . > $repo_dir/t/scanner/examples/$TEST.in
#+END_EXAMPLE
* Test output
** Creating the *.out file
This file contains the expected output of copyright scanner and must
be created whether the test input is a =*.d= directory or a =*.in= file.
#+BEGIN_EXAMPLE
# create .out file
cd - # back to libconfig-model-dpkg-perl repo
perl t/scanner/scan-copyright.t -fix $TEST
#+END_EXAMPLE
Be sure to check that the test output makes sense before answering =y=
to the question asked by =scan-copyright.t=.
** Creating a long out file
=scan-copyright= can also be run with =--long= option to provide a
verbose copyright file (i.e. without wild card).
Such a test case can be added (on top of the regular =.out= file) with:
#+begin_example
# use either $TEST.in or $TEST.d as scan-copyrights argument
touch t/scanner/examples/$TEST-long.out
perl t/scanner/scan-copyright.t -fix $TEST
#+end_example
** Updating the test case
The =*.out= files may need to be regenerated if =lib/Dpkg/Copyright/Scanner.pm=
is changed. To do so, use a command like:
#+BEGIN_EXAMPLE
export TEST=bar
perl t/scanner/scan-copyright.t -fix $TEST
#+END_EXAMPLE
If all tests need to be changed, run:
#+BEGIN_EXAMPLE
export TEST=bar
perl t/scanner/scan-copyright.t -fix
#+END_EXAMPLE
Be sure to check that the updated output makes sense.
|
