SDK automation prep for html (#3222) (#3268)

Author: rmurray-r7

plugins/html/.CHECKSUM

@@ -1,7 +1,7 @@
 {
-	"spec": "1c682e5751de39f77df69ff820118640",
-	"manifest": "f8496c6f37c90b1549c58634683b21a8",
-	"setup": "8f8d60fa7c130285701aae5de46f6632",
+	"spec": "49b79f0e8c4dfb3c6353812371d05915",
+	"manifest": "d65ccfe2f8602b7dd112633062b099fb",
+	"setup": "db867dafc899650683988f858d827f3e",
 	"schemas": [
 		{
 			"identifier": "docx/schema.py",

plugins/html/Dockerfile

@@ -1,23 +1,23 @@
-FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.1.3
+FROM --platform=linux/amd64 rapid7/insightconnect-python-3-slim-plugin:6.2.5
 
 LABEL organization=rapid7
 LABEL sdk=python
-LABEL type=plugin
-
-RUN apt-get update && apt-get install -y texlive lmodern --no-install-recommends
 
 WORKDIR /python/src
 
+RUN apt-get update && apt-get install -y texlive lmodern --no-install-recommends
+# root is required for the conversion to work. If USER set to nobody, actions/tests will fail
+
 ADD ./plugin.spec.yaml /plugin.spec.yaml
 ADD ./requirements.txt /python/src/requirements.txt
 
 RUN if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
 ADD . /python/src
 
-RUN python setup.py build && python setup.py install
+RUN pip install .
 
-# root is required for the conversion to work. If USER set to nobody, actions/tests will fail
+# User to run plugin code. The two supported users are: root, nobody
 USER root
 
 ENTRYPOINT ["/usr/local/bin/icon_html"]

plugins/html/bin/icon_html

@@ -6,7 +6,7 @@ from sys import argv
 
 Name = "HTML"
 Vendor = "rapid7"
-Version = "1.2.7"
+Version = "1.2.8"
 Description = "Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. This plugin provides the ability to convert an HTML document into a variety of formats using [pypandoc](https://pypi.python.org/pypi/pypandoc). Supported formats are: DOCX, EPUB, Markdown, PDF, HTML5, Plain Text"
 
 

plugins/html/help.md

@@ -271,6 +271,7 @@ Example output:
 
 # Version History
 
+* 1.2.8 - Updated SDK to the latest version (6.2.5)
 * 1.2.7 - Initial updates for fedramp compliance | Updated SDK to the latest version
 * 1.2.6 - SDK Bump | Addressing Snyk vulnerabilities | Fixing Unit Tests | Dockerfile USER permission updated
 * 1.2.5 - Update requirements for pypandoc

plugins/html/plugin.spec.yaml

@@ -3,54 +3,64 @@ extension: plugin
 products: [insightconnect]
 name: html
 title: HTML
-description: "Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. This plugin provides the ability to convert an HTML document into a variety of formats using [pypandoc](https://pypi.python.org/pypi/pypandoc). Supported formats are: DOCX, EPUB, Markdown, PDF, HTML5, Plain Text"
-version: 1.2.7
+description: 'Hypertext Markup Language (HTML) is the standard markup language for
+  documents designed to be displayed in a web browser. This plugin provides the ability
+  to convert an HTML document into a variety of formats using [pypandoc](https://pypi.python.org/pypi/pypandoc).
+  Supported formats are: DOCX, EPUB, Markdown, PDF, HTML5, Plain Text'
+version: 1.2.8
 connection_version: 1
 vendor: rapid7
 support: community
-supported_versions: ["2024-09-30"]
+supported_versions: ['2024-09-30']
 status: []
 cloud_ready: true
 fedramp_ready: true
 resources:
   source_url: https://github.com/rapid7/insightconnect-plugins/tree/master/plugins/html
   license_url: https://github.com/rapid7/insightconnect-plugins/blob/master/LICENSE
 tags:
-  - markdown
-  - html
-  - pdf
-  - epub
-  - docx
-  - convert
-  - utilities
+- markdown
+- html
+- pdf
+- epub
+- docx
+- convert
+- utilities
 hub_tags:
   use_cases: [data_utility]
   keywords: [markdown, html, pdf, epub, docx, convert, utilities, cloud_enabled]
   features: []
 sdk:
   type: slim
-  version: 6.1.3
+  version: 6.2.5
   user: root
+  custom_cmd:
+  - RUN apt-get update && apt-get install -y texlive lmodern --no-install-recommends
+  - '# root is required for the conversion to work. If USER set to nobody, actions/tests
+    will fail'
 links:
-  - "[W3 Validator](https://validator.w3.org)"
+- '[W3 Validator](https://validator.w3.org)'
 key_features:
-  - Convert an HTML document into another format to more easily export, share, or edit the document's contents
+- Convert an HTML document into another format to more easily export, share, or edit
+  the document's contents
 version_history:
-  - "1.2.7 - Initial updates for fedramp compliance | Updated SDK to the latest version"
-  - "1.2.6 - SDK Bump | Addressing Snyk vulnerabilities | Fixing Unit Tests | Dockerfile USER permission updated"
-  - "1.2.5 - Update requirements for pypandoc"
-  - "1.2.4 - Actions modified in order to implement PluginExceptions"
-  - "1.2.3 - Action HTML5: fix error with encoding to file"
-  - "1.2.2 - Update to v4 Python plugin runtime"
-  - "1.2.1 - New spec and help.md format for the Extension Library"
-  - "1.2.0 - Update to add the Remove Scripts option to Text"
-  - "1.1.0 - New action: Text"
-  - "1.0.1 - Add `utilities` plugin tag for Marketplace searchability"
-  - "1.0.0 - Update to v2 Python plugin architecture | Support web server mode"
-  - "0.1.1 - SSL bug fix in SDK"
-  - "0.1.0 - Initial plugin"
+- 1.2.8 - Updated SDK to the latest version (6.2.5)
+- 1.2.7 - Initial updates for fedramp compliance | Updated SDK to the latest version
+- 1.2.6 - SDK Bump | Addressing Snyk vulnerabilities | Fixing Unit Tests | Dockerfile
+  USER permission updated
+- 1.2.5 - Update requirements for pypandoc
+- 1.2.4 - Actions modified in order to implement PluginExceptions
+- '1.2.3 - Action HTML5: fix error with encoding to file'
+- 1.2.2 - Update to v4 Python plugin runtime
+- 1.2.1 - New spec and help.md format for the Extension Library
+- 1.2.0 - Update to add the Remove Scripts option to Text
+- '1.1.0 - New action: Text'
+- 1.0.1 - Add `utilities` plugin tag for Marketplace searchability
+- 1.0.0 - Update to v2 Python plugin architecture | Support web server mode
+- 0.1.1 - SSL bug fix in SDK
+- 0.1.0 - Initial plugin
 references:
-  - "[pypandoc](https://pypi.python.org/pypi/pypandoc)"
+- '[pypandoc](https://pypi.python.org/pypi/pypandoc)'
 actions:
   validate:
     title: Validate
@@ -61,7 +71,8 @@ actions:
         description: HTML Contents
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Automate with InsightConnect (HTML)!</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Automate
+          with InsightConnect (HTML)!</p></body></html>
     output:
       validated:
         title: Is Validated
@@ -78,7 +89,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert HTML to Markdown</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert
+          HTML to Markdown</p></body></html>
     output:
       markdown_contents:
         title: Contents
@@ -101,7 +113,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert HTML to HTML5</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert
+          HTML to HTML5</p></body></html>
     output:
       html5_contents:
         title: Contents
@@ -124,7 +137,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert HTML to PDF</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert
+          HTML to PDF</p></body></html>
     output:
       pdf:
         title: PDF
@@ -141,7 +155,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert HTML to EPUB</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert
+          HTML to EPUB</p></body></html>
     output:
       epub:
         title: Epub
@@ -158,7 +173,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: "<!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert HTML to DOCX</p></body></html>"
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect</title></head><body><p>Convert
+          HTML to DOCX</p></body></html>
     output:
       docx:
         title: Docx
@@ -175,7 +191,8 @@ actions:
         description: Document to transform
         type: string
         required: true
-        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect HTML</title></head><body><p>Automate with InsightConnect</p></body></html>
+        example: <!DOCTYPE html><html><head><title>Rapid7 InsightConnect HTML</title></head><body><p>Automate
+          with InsightConnect</p></body></html>
       remove_scripts:
         title: Remove Scripts
         description: Remove non-HTML scripts from the document

plugins/html/setup.py

@@ -3,7 +3,7 @@
 
 
 setup(name="html-rapid7-plugin",
-      version="1.2.7",
+      version="1.2.8",
       description="Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. This plugin provides the ability to convert an HTML document into a variety of formats using [pypandoc](https://pypi.python.org/pypi/pypandoc). Supported formats are: DOCX, EPUB, Markdown, PDF, HTML5, Plain Text",
       author="rapid7",
       author_email="",