Add docker coverage documentation

src/css/custom.css

@@ -142,6 +142,10 @@ div[class^="sidebar_"] .button svg {
   @apply font-bold text-[color:var(--ifm-color-primary)];
 }
 
+th, #lang {
+  text-align: center;
+}
+
 .docs-wrapper aside {
   @apply border-0;
 }

versioned_docs/version-2.0.0/server/sdk-installation/go.md

@@ -18,18 +18,6 @@ keyword:
   - Go Test
 ---
 
-import WhatAreKeployFeatures from './index.md'
-
-<WhatAreKeployFeatures/>
-
-## Usage
-
-For keploy test coverage the binary must built with `-cover` flag:
-
-```go
-go build -cover
-```
-
 To get the coverage data for unit tests :
 
 ```go

versioned_docs/version-2.0.0/server/sdk-installation/index.md

@@ -1,6 +1,6 @@
 ---
 id: index
-title: Pre-requites 🛠️
+title: Test Coverage Generation
 tags:
   - coverage
 keyword:
@@ -24,6 +24,8 @@ To get the coverage report, first make sure all the requirements are met and the
 keploy test -c "your_application_command"
 ```
 
+In case of **docker** command, you would need to set `--skipCoverage` flag to false as by default coverage is disabled. Also language must be explicitly passed through `--language` flag.
+
 After successful execution of this command, A coverage report would be generated inside the test-run folder of keploy/reports.
 
 ```sh
@@ -39,20 +41,86 @@ keploy
         └── test-2.yaml
 ```
 
-**Note**: In case of java application, before running test subcommand, you need to clean the project by removing any previously generated file, and run install command.
-
+:::note
+In case of java application, before running test subcommand, you need to clean the target folder by removing any previously generated file, and then running install command. Else you may get [class mismatch error](https://www.eclemma.org/jacoco/trunk/doc/classids.html) or total coverage percentage would come out to be 0.
 ```bash
 mvn clean install -Dmaven.test.skip=true
 ```
+:::
+
 
 ## 🛠️ Language Specific Requirements
 
-| Programming Language | Prerequisites                                                                                                                                                                                                                                                       |
-| :------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-|          go          | 1. The application should have a graceful shutdown to stop the API server on `SIGTERM` or `SIGINT` signals. Refer [appendix](#graceful-shutdown) for basic implementation of graceful shutdown function. <br/> 2. The go binary should be built with `-cover` flag. |
-|        python        | [Python 3 and above](https://www.python.org/downloads/) <br/> [coverage.py](https://coverage.readthedocs.io/en/7.4.1/install.html)                                                                                                                                  |
-|      javascript      | [nyc](https://www.npmjs.com/package/nyc)                                                                                                                                                                                                                            |
-|         java         | [Jacoco 0.8.8](https://mvnrepository.com/artifact/org.jacoco/jacoco-maven-plugin/0.8.8)                                                                                                                                                                             |
+<table>
+  <tr>
+    <th rowspan="2">
+      Programming Language
+    </th>
+    <th colspan="2" width="80%">
+      Prerequisites
+    </th>
+  </tr>
+  <tr>
+    <th>Native</th>
+    <th>Docker</th>
+  </tr>
+  <tr>
+    <td id="lang">
+      go
+    </td>
+    <td colspan="2">
+      1. The application should have a graceful shutdown to stop the API server on `SIGTERM` or `SIGINT` signals. Refer [appendix](#graceful-shutdown) for basic implementation of graceful shutdown function. 
+      2. The go binary should be built with `-cover` flag.
+    </td>
+  </tr>
+  <tr>
+    <td id="lang">
+      python
+    </td>
+    <td>
+      [coverage.py v7.6.0 and above](https://coverage.readthedocs.io/en/7.6.0/install.html)
+    </td>
+    <td>
+      update your CMD instruction to:<br/>
+      `CMD ["sh", "-c", "python3 -m coverage run $APPEND --data-file=.coverage.keploy app.py"]`,<br/>
+      where app.py will be the program to run.
+    </td>
+  </tr>
+  <tr>
+    <td id="lang">
+      javascript
+    </td>
+    <td>
+      [nyc](https://www.npmjs.com/package/nyc)
+    </td>
+    <td>
+    1. Add a new script to package.json: <br/>
+    `"keploy-coverage": "nyc --clean=$CLEAN npm run start",`
+    2. Change the CMD instruction to: <br/>
+    `CMD [ "npm", "run", "keploy-coverage" ]`
+    </td>
+  </tr>
+  <tr>
+    <td id="lang">
+      java
+    </td>
+    <td>
+      [Jacoco](https://mvnrepository.com/artifact/org.jacoco/jacoco-maven-plugin/0.8.8)
+    </td>
+    <td>
+    Update the CMD instruction to:<br/>
+    `CMD ["sh", "-c", "java $JACOCOAGENT -jar <your_application_jar_path>"]`
+    </td>
+  </tr>
+</table>
+
+:::note
+If container fails to stop after keploy test-set run, then include the below instructions in your dockerfile:
+```sh
+RUN apt-get install -y dumb-init
+ENTRYPOINT [ "dumb-init", "--" ]
+```
+:::
 
 ## Graceful Shutdown
 

versioned_docs/version-2.0.0/server/sdk-installation/java.md

@@ -18,12 +18,6 @@ keyword:
   - Junit
 ---
 
-import WhatAreKeployFeatures from './index.md'
-
-<WhatAreKeployFeatures/>
-
-## Usage
-
 ### Update `pom.xml` file
 
 You will need to add the following plugins in `pom.xml` file of your application. :-

versioned_docs/version-2.0.0/server/sdk-installation/javascript.md

@@ -21,12 +21,6 @@ keywords:
   - Typescript
 ---
 
-import WhatAreKeployFeatures from './index.md'
-
-<WhatAreKeployFeatures/>
-
-## Usage
-
 ### Update package file
 
 Update the `package.json` file that runs the application:

versioned_docs/version-2.0.0/server/sdk-installation/python.md

@@ -16,12 +16,6 @@ keyword:
   - Pytest
 ---
 
-import WhatAreKeployFeatures from './index.md'
-
-<WhatAreKeployFeatures/>
-
-## Usage
-
 To get the coverage data for your unit tests:
 
 ```sh

versioned_sidebars/version-2.0.0-sidebars.json

@@ -46,6 +46,10 @@
       "label": "Test Coverage Generation",
       "collapsible": true,
       "collapsed": true,
+      "link": {
+        "type": "doc",
+        "id": "server/sdk-installation/index"
+      },
       "items": [
         "server/sdk-installation/go",
         "server/sdk-installation/java",