refactor(descriptions): remove pkg/descriptions and related CLI flag

.github/workflows/go-ci-integration.yml

@@ -58,7 +58,6 @@ jobs:
           docker run --user $(id -u):$(id -g) -v ${PWD}/assets/queries:/path \
             kics:${{ github.sha }} scan \
             --silent \
-            --disable-full-descriptions \
             --ignore-on-exit "results" \
             --log-level DEBUG \
             --log-path "/path/info.log" \

docs/commands.md

@@ -40,8 +40,7 @@ Use "kics [command] --help" for more information about a command.
 |-m, --bom                           | include bill of materials (BoM) in results output                                                                                                                                                                                                                                           |
 |      --cloud-provider strings      | list of cloud providers to scan (alicloud,aws,azure,gcp,nifcloud,tencentcloud)                                                                                                                                                                                                              |
 |      --config string               | path to configuration file                                                                                                                                                                                                                                                                  |
-|      --old-severities              | uses old severities in query results                                                                                                                                                                                                                                                        |
-|      --disable-full-descriptions   | disable request for full descriptions and use default vulnerability descriptions                                                                                                                                                                                                            |
+|      --old-severities              | uses old severities in query results                                                                                                                                                                                             |
 |      --disable-secrets             | disable secrets scanning                                                                                                                                                                                                                                                                    |
 |      --enable-openapi-refs         | resolve the file reference, on OpenAPI files (default [false])                                                                                                                                                                                                                              |
 |      --exclude-categories strings  | exclude categories by providing its name<br>cannot be provided with query inclusion flags<br>can be provided multiple times or as a comma separated string<br>example: 'Access control,Best practices'                                                                                      |

docs/dockerhub.md

@@ -110,7 +110,6 @@ Flags:
       --cloud-provider strings        list of cloud providers to scan (alicloud,aws,azure,gcp,nifcloud,tencentcloud)
       --config string                 path to configuration file
       --old-severities                use old severities in query results (excludes critical severity)
-      --disable-full-descriptions     disable request for full descriptions and use default vulnerability descriptions
       --disable-secrets               disable secrets scanning
       --enable-openapi-refs           resolve the file reference, on OpenAPI files (default [false]) 
       --exclude-categories strings    exclude categories by providing its name

docs/flags.md

@@ -41,11 +41,11 @@ Example of a valid `flags.json` file:
 To mark a flag as hidden use the following configuration:
 ```json
 {
-  "disable-full-descriptions": {
+  "log-file": {
     "flagType": "bool",
-    "shorthandFlag": "",
+    "shorthandFlag": "l",
     "defaultValue": "false",
-    "usage": "disable request for full descriptions and use default vulnerability descriptions",
+    "usage": "writes log messages to log file",
     "hidden": true
   }
 }
@@ -55,14 +55,14 @@ If you also want to display a flag deprecation warning you can define it like th
 
 ```json
 {
-  "disable-full-descriptions": {
+  "log-file": {
     "flagType": "bool",
-    "shorthandFlag": "",
+    "shorthandFlag": "l",
     "defaultValue": "false",
-    "usage": "disable request for full descriptions and use default vulnerability descriptions",
+    "usage": "writes log messages to log file",
     "hidden": true,
     "deprecated": true,
-    "deprecatedInfo": "use --disable-full-descriptions instead"
+    "deprecatedInfo": "please use --log-path instead"
   }
 }
 ```

e2e/README.md

@@ -21,7 +21,7 @@ npm start
 
 - **Running E2E Tests from binary (faster) (used in dev/local):**
 
-_Note: for Windows only the test "092" must fail and, for Linux, only the test "052" should fail._
+_Note: for Windows only the test "092" must fail and, for Linux, only the test "051" should fail._
 
 Prepare
 ```bash
@@ -42,7 +42,7 @@ go test "github.com/Checkmarx/kics/v2/e2e" -v -count=1 -tags dev
 
 - **Running E2E Tests from docker (slower) (used in CI):**
 
-_Note: when running the tests from docker, only the tests "031" and "052" should fail_.
+_Note: when running the tests from docker, only the tests "031" and "051" should fail_.
 
 Prepare
 ```bash

e2e/fixtures/E2E_CLI_058

@@ -0,0 +1,3 @@
+Auto remediates the project
+
+{{.RemediateHelp}}

e2e/fixtures/E2E_CLI_059

@@ -1,3 +1,2 @@
-Auto remediates the project
-
-{{.RemediateHelp}}
+Error: required flag(s) "results" not set
+{{.RemediateHelp}}

e2e/fixtures/E2E_CLI_060_PAYLOAD.json

@@ -0,0 +1,163 @@
+{
+	"document": [
+		{
+      "id": "0",
+			"file": "file",
+			"args": [],
+			"command": {
+				"alpine:3.5": [
+					{
+						"Cmd": "from",
+						"EndLine": 1,
+						"Flags": [],
+						"JSON": false,
+						"Original": "FROM alpine:3.5",
+						"SubCmd": "",
+						"Value": [
+							"alpine:3.5"
+						],
+						"_kics_line": 1
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 2,
+						"Flags": [],
+						"JSON": false,
+						"Original": "RUN apk add --update py2-pip",
+						"SubCmd": "",
+						"Value": [
+							"apk add --update py2-pip"
+						],
+						"_kics_line": 2
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 3,
+						"Flags": [],
+						"JSON": false,
+						"Original": "RUN gem install bundler",
+						"SubCmd": "",
+						"Value": [
+							"gem install bundler"
+						],
+						"_kics_line": 3
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 4,
+						"Flags": [],
+						"JSON": true,
+						"Original": "RUN [\"gem\", \"install\", \"blunder\"]",
+						"SubCmd": "",
+						"Value": [
+							"gem",
+							"install",
+							"blunder"
+						],
+						"_kics_line": 4
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 5,
+						"Flags": [],
+						"JSON": false,
+						"Original": "RUN gem install grpc -v ${GRPC_RUBY_VERSION} blunder",
+						"SubCmd": "",
+						"Value": [
+							"gem install grpc -v ${GRPC_RUBY_VERSION} blunder"
+						],
+						"_kics_line": 5
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 6,
+						"Flags": [],
+						"JSON": false,
+						"Original": "RUN bundle install",
+						"SubCmd": "",
+						"Value": [
+							"bundle install"
+						],
+						"_kics_line": 6
+					},
+					{
+						"Cmd": "copy",
+						"EndLine": 7,
+						"Flags": [],
+						"JSON": false,
+						"Original": "COPY requirements.txt /usr/src/app/",
+						"SubCmd": "",
+						"Value": [
+							"requirements.txt",
+							"/usr/src/app/"
+						],
+						"_kics_line": 7
+					},
+					{
+						"Cmd": "run",
+						"EndLine": 8,
+						"Flags": [],
+						"JSON": false,
+						"Original": "RUN pip install --no-cache-dir -r /usr/src/app/requirements.txt",
+						"SubCmd": "",
+						"Value": [
+							"pip install --no-cache-dir -r /usr/src/app/requirements.txt"
+						],
+						"_kics_line": 8
+					},
+					{
+						"Cmd": "copy",
+						"EndLine": 9,
+						"Flags": [],
+						"JSON": false,
+						"Original": "COPY app.py /usr/src/app/",
+						"SubCmd": "",
+						"Value": [
+							"app.py",
+							"/usr/src/app/"
+						],
+						"_kics_line": 9
+					},
+					{
+						"Cmd": "copy",
+						"EndLine": 10,
+						"Flags": [],
+						"JSON": false,
+						"Original": "COPY templates/index.html /usr/src/app/templates/",
+						"SubCmd": "",
+						"Value": [
+							"templates/index.html",
+							"/usr/src/app/templates/"
+						],
+						"_kics_line": 10
+					},
+					{
+						"Cmd": "expose",
+						"EndLine": 11,
+						"Flags": [],
+						"JSON": false,
+						"Original": "EXPOSE 5000",
+						"SubCmd": "",
+						"Value": [
+							"5000"
+						],
+						"_kics_line": 11
+					},
+					{
+						"Cmd": "cmd",
+						"EndLine": 12,
+						"Flags": [],
+						"JSON": true,
+						"Original": "CMD [\"python\", \"/usr/src/app/app.py\"]",
+						"SubCmd": "",
+						"Value": [
+							"python",
+							"/usr/src/app/app.py"
+						],
+						"_kics_line": 12
+					}
+				]
+			}
+		}
+	]
+}