Rename headers.tool to tool_name #211

As suggested by @sschuberth in aboutcode-org/aboutcode#7 (comment) Signed-off-by: Philippe Ombredanne <[email protected]>
aboutcode-org · Nov 27, 2018 · 8858d5c · 8858d5c
1 parent 890f127
commit 8858d5c
Show file tree

Hide file tree

Showing 71 changed files with 72 additions and 72 deletions.
diff --git a/src/scancode/cli.py b/src/scancode/cli.py
@@ -715,7 +715,7 @@ def scancode(ctx, input,  # NOQA
         # update headers
         cle = codebase.get_or_create_current_header()
         cle.start_timestamp = start_timestamp
-        cle.tool = 'scancode-toolkit'
+        cle.tool_name = 'scancode-toolkit'
         cle.tool_version = scancode_version
         cle.notice = notice
         cle.options = get_pretty_params(ctx, generic_paths=test_mode)

diff --git a/src/scancode/resource.py b/src/scancode/resource.py
@@ -132,7 +132,7 @@ class Header(object):
     Represent a codebase header. Each tool that transforms the codebase
     should create a Header and append it to the codebase log_entries list.
     """
-    tool = String(help='Tool used such as scancode-toolkit.')
+    tool_name = String(help='Name of the tool used such as scancode-toolkit.')
     tool_version = String(default='', help='Tool version used such as v1.2.3.')
     options = Mapping(help='Mapping of key/values describing the options used with this tool.')
     notice = String(default='', help='Notice text for this tool.')
@@ -152,7 +152,7 @@ def from_dict(cls, **kwargs):
         key/values. Unknown attributes are ignored.
         """
         known_attributes = set([
-            'tool',
+            'tool_name',
             'tool_version',
             'options',
             'notice',

diff --git a/tests/cluecode/data/plugin_email_url/emails-threshold.expected.json b/tests/cluecode/data/plugin_email_url/emails-threshold.expected.json
@@ -10,7 +10,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--email": true,

diff --git a/tests/cluecode/data/plugin_email_url/emails.expected.json b/tests/cluecode/data/plugin_email_url/emails.expected.json
@@ -9,7 +9,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--email": true,

diff --git a/tests/cluecode/data/plugin_email_url/urls-threshold.expected.json b/tests/cluecode/data/plugin_email_url/urls-threshold.expected.json
@@ -10,7 +10,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/cluecode/data/plugin_email_url/urls.expected.json b/tests/cluecode/data/plugin_email_url/urls.expected.json
@@ -9,7 +9,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/cluecode/data/plugin_ignore_copyrights/authors.expected.json b/tests/cluecode/data/plugin_ignore_copyrights/authors.expected.json
@@ -11,7 +11,7 @@
   "files_count": 5,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/cluecode/data/plugin_ignore_copyrights/holders.expected.json b/tests/cluecode/data/plugin_ignore_copyrights/holders.expected.json
@@ -11,7 +11,7 @@
   "files_count": 5,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/formattedcode/data/json/simple-expected.json b/tests/formattedcode/data/json/simple-expected.json
@@ -11,7 +11,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/formattedcode/data/json/simple-expected.jsonlines b/tests/formattedcode/data/json/simple-expected.jsonlines
@@ -10,7 +10,7 @@
       "files_count": 1,
       "headers": [
         {
-          "tool": "scancode-toolkit",
+          "tool_name": "scancode-toolkit",
           "options": {
             "input": "<path>",
             "--info": true,

diff --git a/tests/formattedcode/data/json/simple-expected.jsonpp b/tests/formattedcode/data/json/simple-expected.jsonpp
@@ -11,7 +11,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/formattedcode/data/json/tree/expected.json b/tests/formattedcode/data/json/tree/expected.json
@@ -12,7 +12,7 @@
   "files_count": 7,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/licensedcode/data/plugin_license/license-expression/scan.expected.json b/tests/licensedcode/data/plugin_license/license-expression/scan.expected.json
@@ -10,7 +10,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/licensedcode/data/plugin_license/license_url.expected.json b/tests/licensedcode/data/plugin_license/license_url.expected.json
@@ -9,7 +9,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json-pp": "<file>",

diff --git a/tests/scancode/data/altpath/copyright.expected.json b/tests/scancode/data/altpath/copyright.expected.json
@@ -10,7 +10,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/composer/composer.expected.json b/tests/scancode/data/composer/composer.expected.json
@@ -8,7 +8,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/scancode/data/failing/patchelf.expected.json b/tests/scancode/data/failing/patchelf.expected.json
@@ -9,7 +9,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/info/all.expected.json b/tests/scancode/data/info/all.expected.json
@@ -11,7 +11,7 @@
   "files_count": 6,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/info/all.rooted.expected.json b/tests/scancode/data/info/all.rooted.expected.json
@@ -11,7 +11,7 @@
   "files_count": 6,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/info/basic.expected.json b/tests/scancode/data/info/basic.expected.json
@@ -9,7 +9,7 @@
   "files_count": 6,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/info/basic.rooted.expected.json b/tests/scancode/data/info/basic.rooted.expected.json
@@ -8,7 +8,7 @@
   "files_count": 6,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/info/email_url_info.expected.json b/tests/scancode/data/info/email_url_info.expected.json
@@ -11,7 +11,7 @@
   "files_count": 6,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--email": true,

diff --git a/tests/scancode/data/license_text/test.expected b/tests/scancode/data/license_text/test.expected
@@ -10,7 +10,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/scancode/data/non_utf8/expected-linux.json b/tests/scancode/data/non_utf8/expected-linux.json
@@ -9,7 +9,7 @@
   "files_count": 18,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/non_utf8/expected-mac.json b/tests/scancode/data/non_utf8/expected-mac.json
@@ -9,7 +9,7 @@
   "files_count": 18,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/non_utf8/expected-win.json b/tests/scancode/data/non_utf8/expected-win.json
@@ -9,7 +9,7 @@
   "files_count": 18,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/plugin_mark_source/with_info.expected.json b/tests/scancode/data/plugin_mark_source/with_info.expected.json
@@ -9,7 +9,7 @@
   "files_count": 12,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/plugin_only_findings/errors.expected.json b/tests/scancode/data/plugin_only_findings/errors.expected.json
@@ -11,7 +11,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/plugin_only_findings/expected.json b/tests/scancode/data/plugin_only_findings/expected.json
@@ -12,7 +12,7 @@
   "files_count": 2,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/plugin_only_findings/info.expected.json b/tests/scancode/data/plugin_only_findings/info.expected.json
@@ -9,7 +9,7 @@
   "files_count": 0,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/resource/virtual_idempotent/codebase.json b/tests/scancode/data/resource/virtual_idempotent/codebase.json
@@ -25,7 +25,7 @@
   "files_count": 33,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "tool_version": "2.9.7.post135.90333b4",
       "options": {
         "input": "samples/",

diff --git a/tests/scancode/data/rpm/fping-2.4-0.b2.rhfc1.dag.i386.rpm.expected.json b/tests/scancode/data/rpm/fping-2.4-0.b2.rhfc1.dag.i386.rpm.expected.json
@@ -8,7 +8,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--json": "<file>",

diff --git a/tests/scancode/data/single/iproute.expected.json b/tests/scancode/data/single/iproute.expected.json
@@ -9,7 +9,7 @@
   "files_count": 1,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--info": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-linux.json b/tests/scancode/data/unicodepath/unicodepath.expected-linux.json
@@ -14,7 +14,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-linux.json--quiet b/tests/scancode/data/unicodepath/unicodepath.expected-linux.json--quiet
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-linux.json--verbose b/tests/scancode/data/unicodepath/unicodepath.expected-linux.json--verbose
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-mac.json b/tests/scancode/data/unicodepath/unicodepath.expected-mac.json
@@ -14,7 +14,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-mac.json--quiet b/tests/scancode/data/unicodepath/unicodepath.expected-mac.json--quiet
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-mac.json--verbose b/tests/scancode/data/unicodepath/unicodepath.expected-mac.json--verbose
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-win.json b/tests/scancode/data/unicodepath/unicodepath.expected-win.json
@@ -14,7 +14,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-win.json--quiet b/tests/scancode/data/unicodepath/unicodepath.expected-win.json--quiet
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/unicodepath/unicodepath.expected-win.json--verbose b/tests/scancode/data/unicodepath/unicodepath.expected-win.json--verbose
@@ -15,7 +15,7 @@
   "files_count": 3,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,

diff --git a/tests/scancode/data/weird_file_name/expected-linux.json b/tests/scancode/data/weird_file_name/expected-linux.json
@@ -10,7 +10,7 @@
   "files_count": 5,
   "headers": [
     {
-      "tool": "scancode-toolkit",
+      "tool_name": "scancode-toolkit",
       "options": {
         "input": "<path>",
         "--copyright": true,