fix(release): build script now updates most recent archive (#6)

Author: alemagio

.github/workflows/main.yml

@@ -37,6 +37,8 @@ jobs:
           node-version: '12'
       - name: install dependencies
         run: yarn install --frozen-lockfile --ignore-engines
+      - name: build script
+        run: yarn run build
       - name: release
         run: yarn run semantic-release
         env:

build/build.js

@@ -3,34 +3,64 @@
 const path = require('path')
 const debug = require('debug')('cwe-sdk:build')
 const { convertXmlArchiveToJson, writeJsonToFile, createCweDictionary } = require('./xmlParser')
-
-debug('begin building CWE assets')
+const request = require('./httpClient')
+const AdmZip = require('adm-zip')
+const { rename } = require('fs').promises
 
 // @TODO add a script that creates a copy of cwec_v4.1.xml to
 // its alias cwe-archive.xml
 const RAW_INPUT_XML_FILENAME = 'cwe-archive.xml'
 const RAW_OUTPUT_JSON_FILENAME = 'cwe-archive.json'
 const OUTPUT_JSON_DICT_FILENAME = 'cwe-dictionary.json'
 const OUTPUT_JSON_HIERARCHY_FILENAME = 'cwe-hierarchy.json'
+const ARCHIVE_DOWNLOAD_OPTIONS = {
+  hostname: 'cwe.mitre.org',
+  port: 443,
+  path: '/data/xml/cwec_latest.xml.zip',
+  method: 'GET'
+}
+let cweArchiveVersion
+
+debug('begin downloading latest CWE archive')
+
+updateArchive()
+  .then(() => {
+    debug(`archive updated to version ${cweArchiveVersion}`)
+    debug('begin building CWE assets')
+
+    const rawJsonCweArchive = convertXmlArchiveToJson({
+      cweArchiveFilepath: path.join(__dirname, '..', 'raw', RAW_INPUT_XML_FILENAME)
+    })
+    writeJsonToFile({
+      jsonFilepath: path.join(__dirname, '..', 'raw', RAW_OUTPUT_JSON_FILENAME),
+      jsonData: rawJsonCweArchive
+    })
+
+    const { cweDictionary, cweHierarchy } = createCweDictionary({ cweArchive: rawJsonCweArchive })
 
-const rawJsonCweArchive = convertXmlArchiveToJson({
-  cweArchiveFilepath: path.join(__dirname, '..', 'raw', RAW_INPUT_XML_FILENAME)
-})
-writeJsonToFile({
-  jsonFilepath: path.join(__dirname, '..', 'raw', RAW_OUTPUT_JSON_FILENAME),
-  jsonData: rawJsonCweArchive
-})
+    writeJsonToFile({
+      jsonFilepath: path.join(__dirname, '..', 'raw', OUTPUT_JSON_DICT_FILENAME),
+      jsonData: cweDictionary
+    })
 
-const { cweDictionary, cweHierarchy } = createCweDictionary({ cweArchive: rawJsonCweArchive })
+    writeJsonToFile({
+      jsonFilepath: path.join(__dirname, '..', 'raw', OUTPUT_JSON_HIERARCHY_FILENAME),
+      jsonData: cweHierarchy
+    })
 
-writeJsonToFile({
-  jsonFilepath: path.join(__dirname, '..', 'raw', OUTPUT_JSON_DICT_FILENAME),
-  jsonData: cweDictionary
-})
+    debug('finished')
+  })
+  .catch(console.error)
 
-writeJsonToFile({
-  jsonFilepath: path.join(__dirname, '..', 'raw', OUTPUT_JSON_HIERARCHY_FILENAME),
-  jsonData: cweHierarchy
-})
+async function updateArchive() {
+  const { data } = await request(ARCHIVE_DOWNLOAD_OPTIONS)
 
-debug('finished')
+  const zip = new AdmZip(data)
+  const zippedFile = zip.getEntries()[0].entryName
+  cweArchiveVersion = zippedFile.substring(zippedFile.search(/v/) + 1, zippedFile.search(/\.xml/))
+  zip.extractEntryTo(zippedFile, 'raw', false)
+  return rename(
+    path.join(__dirname, '..', 'raw', zippedFile),
+    path.join(__dirname, '..', 'raw', RAW_INPUT_XML_FILENAME)
+  )
+}

build/httpClient.js

@@ -0,0 +1,18 @@
+const requestOriginal = require('https').request
+
+module.exports = function(options) {
+  return new Promise((resolve, reject) => {
+    const req = requestOriginal(options, response => {
+      const chunks = []
+      response.on('data', data => {
+        chunks.push(data)
+      })
+
+      response.on('end', () => {
+        resolve({ response, data: Buffer.concat(chunks) })
+      })
+    })
+    req.on('error', reject)
+    req.end()
+  })
+}

package.json

@@ -53,6 +53,7 @@
     "@semantic-release/github": "^5.4.2",
     "@semantic-release/npm": "^5.1.13",
     "@semantic-release/release-notes-generator": "^7.2.1",
+    "adm-zip": "^0.4.16",
     "babel-eslint": "^10.0.1",
     "babel-plugin-syntax-async-functions": "^6.13.0",
     "babel-plugin-transform-regenerator": "^6.26.0",
@@ -218,4 +219,4 @@
     "raw",
     "src"
   ]
-}
+}