nodebots-interchange

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/downloader.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="../index.html">All files</a> / <a href="index.html">lib</a> downloader.js</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 96.4% Statements 107/111 </div> <div class='fl pad1y space-right2'> 94.12% Branches 48/51 </div> <div class='fl pad1y space-right2'> 95.65% Functions 22/23 </div> <div class='fl pad1y space-right2'> 96.4% Lines 107/111 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a> <a name='L153'></a><a href='#L153'>153</a> <a name='L154'></a><a href='#L154'>154</a> <a name='L155'></a><a href='#L155'>155</a> <a name='L156'></a><a href='#L156'>156</a> <a name='L157'></a><a href='#L157'>157</a> <a name='L158'></a><a href='#L158'>158</a> <a name='L159'></a><a href='#L159'>159</a> <a name='L160'></a><a href='#L160'>160</a> <a name='L161'></a><a href='#L161'>161</a> <a name='L162'></a><a href='#L162'>162</a> <a name='L163'></a><a href='#L163'>163</a> <a name='L164'></a><a href='#L164'>164</a> <a name='L165'></a><a href='#L165'>165</a> <a name='L166'></a><a href='#L166'>166</a> <a name='L167'></a><a href='#L167'>167</a> <a name='L168'></a><a href='#L168'>168</a> <a name='L169'></a><a href='#L169'>169</a> <a name='L170'></a><a href='#L170'>170</a> <a name='L171'></a><a href='#L171'>171</a> <a name='L172'></a><a href='#L172'>172</a> <a name='L173'></a><a href='#L173'>173</a> <a name='L174'></a><a href='#L174'>174</a> <a name='L175'></a><a href='#L175'>175</a> <a name='L176'></a><a href='#L176'>176</a> <a name='L177'></a><a href='#L177'>177</a> <a name='L178'></a><a href='#L178'>178</a> <a name='L179'></a><a href='#L179'>179</a> <a name='L180'></a><a href='#L180'>180</a> <a name='L181'></a><a href='#L181'>181</a> <a name='L182'></a><a href='#L182'>182</a> <a name='L183'></a><a href='#L183'>183</a> <a name='L184'></a><a href='#L184'>184</a> <a name='L185'></a><a href='#L185'>185</a> <a name='L186'></a><a href='#L186'>186</a> <a name='L187'></a><a href='#L187'>187</a> <a name='L188'></a><a href='#L188'>188</a> <a name='L189'></a><a href='#L189'>189</a> <a name='L190'></a><a href='#L190'>190</a> <a name='L191'></a><a href='#L191'>191</a> <a name='L192'></a><a href='#L192'>192</a> <a name='L193'></a><a href='#L193'>193</a> <a name='L194'></a><a href='#L194'>194</a> <a name='L195'></a><a href='#L195'>195</a> <a name='L196'></a><a href='#L196'>196</a> <a name='L197'></a><a href='#L197'>197</a> <a name='L198'></a><a href='#L198'>198</a> <a name='L199'></a><a href='#L199'>199</a> <a name='L200'></a><a href='#L200'>200</a> <a name='L201'></a><a href='#L201'>201</a> <a name='L202'></a><a href='#L202'>202</a> <a name='L203'></a><a href='#L203'>203</a> <a name='L204'></a><a href='#L204'>204</a> <a name='L205'></a><a href='#L205'>205</a> <a name='L206'></a><a href='#L206'>206</a> <a name='L207'></a><a href='#L207'>207</a> <a name='L208'></a><a href='#L208'>208</a> <a name='L209'></a><a href='#L209'>209</a> <a name='L210'></a><a href='#L210'>210</a> <a name='L211'></a><a href='#L211'>211</a> <a name='L212'></a><a href='#L212'>212</a> <a name='L213'></a><a href='#L213'>213</a> <a name='L214'></a><a href='#L214'>214</a> <a name='L215'></a><a href='#L215'>215</a> <a name='L216'></a><a href='#L216'>216</a> <a name='L217'></a><a href='#L217'>217</a> <a name='L218'></a><a href='#L218'>218</a> <a name='L219'></a><a href='#L219'>219</a> <a name='L220'></a><a href='#L220'>220</a> <a name='L221'></a><a href='#L221'>221</a> <a name='L222'></a><a href='#L222'>222</a> <a name='L223'></a><a href='#L223'>223</a> <a name='L224'></a><a href='#L224'>224</a> <a name='L225'></a><a href='#L225'>225</a> <a name='L226'></a><a href='#L226'>226</a> <a name='L227'></a><a href='#L227'>227</a> <a name='L228'></a><a href='#L228'>228</a> <a name='L229'></a><a href='#L229'>229</a> <a name='L230'></a><a href='#L230'>230</a> <a name='L231'></a><a href='#L231'>231</a> <a name='L232'></a><a href='#L232'>232</a> <a name='L233'></a><a href='#L233'>233</a> <a name='L234'></a><a href='#L234'>234</a> <a name='L235'></a><a href='#L235'>235</a> <a name='L236'></a><a href='#L236'>236</a> <a name='L237'></a><a href='#L237'>237</a> <a name='L238'></a><a href='#L238'>238</a> <a name='L239'></a><a href='#L239'>239</a> <a name='L240'></a><a href='#L240'>240</a> <a name='L241'></a><a href='#L241'>241</a> <a name='L242'></a><a href='#L242'>242</a> <a name='L243'></a><a href='#L243'>243</a> <a name='L244'></a><a href='#L244'>244</a> <a name='L245'></a><a href='#L245'>245</a> <a name='L246'></a><a href='#L246'>246</a> <a name='L247'></a><a href='#L247'>247</a> <a name='L248'></a><a href='#L248'>248</a> <a name='L249'></a><a href='#L249'>249</a> <a name='L250'></a><a href='#L250'>250</a> <a name='L251'></a><a href='#L251'>251</a> <a name='L252'></a><a href='#L252'>252</a> <a name='L253'></a><a href='#L253'>253</a> <a name='L254'></a><a href='#L254'>254</a> <a name='L255'></a><a href='#L255'>255</a> <a name='L256'></a><a href='#L256'>256</a> <a name='L257'></a><a href='#L257'>257</a> <a name='L258'></a><a href='#L258'>258</a> <a name='L259'></a><a href='#L259'>259</a> <a name='L260'></a><a href='#L260'>260</a> <a name='L261'></a><a href='#L261'>261</a> <a name='L262'></a><a href='#L262'>262</a> <a name='L263'></a><a href='#L263'>263</a> <a name='L264'></a><a href='#L264'>264</a> <a name='L265'></a><a href='#L265'>265</a> <a name='L266'></a><a href='#L266'>266</a> <a name='L267'></a><a href='#L267'>267</a> <a name='L268'></a><a href='#L268'>268</a> <a name='L269'></a><a href='#L269'>269</a> <a name='L270'></a><a href='#L270'>270</a> <a name='L271'></a><a href='#L271'>271</a> <a name='L272'></a><a href='#L272'>272</a> <a name='L273'></a><a href='#L273'>273</a> <a name='L274'></a><a href='#L274'>274</a> <a name='L275'></a><a href='#L275'>275</a> <a name='L276'></a><a href='#L276'>276</a> <a name='L277'></a><a href='#L277'>277</a> <a name='L278'></a><a href='#L278'>278</a> <a name='L279'></a><a href='#L279'>279</a> <a name='L280'></a><a href='#L280'>280</a> <a name='L281'></a><a href='#L281'>281</a> <a name='L282'></a><a href='#L282'>282</a></td><td class="line-coverage quiet">  4x 4x 4x 4x 4x 4x 4x 4x           30x   30x 27x   3x                   14x 1x     13x 1x     12x     12x 1x 11x   1x     11x 1x     11x   11x           3x 1x       2x 2x 2x   2x 2x   1x     1x         9x 1x     8x 1x     7x         3x   1x   1x       2x                 6x 6x 1x     6x 1x     6x           6x 6x     6x 1x               6x 1x     5x 5x 5x     5x 3x   1x 1x   2x 2x     3x 3x 3x   1x     4x 3x 1x       3x 3x     3x   2x 2x     2x     2x   2x                 1x             4x               4x     4x 1x   3x   2x   1x       4x   4x   1x     4x     4x 4x               4x           5x   5x   5x       5x 1x 1x           5x   2x     2x     4x   2x   2x         4x  </td><td class="text"><pre class="prettyprint lang-js">// This module executes the downloading of the files properly. const axios = require('axios'); const child_process = require('child_process'); const colors = require('colors'); const fs = require('fs'); const fsextra = require('fs-extra'); const path = require('path'); const tmp = require('tmp'); const util = require('util');   class Downloader { constructor(opts) { // set up the defaults   this.fw = undefined;   if (typeof(opts) === 'undefined') { this.fw = undefined; } else { this.fw = opts.fw || undefined; } }     get_path_from_manifest(manifest, options) { // takes the manifest data and returns the path to the hex file   // TODO - put in the bits here around installing from GH and having // multiple options. if (typeof(manifest) === 'undefined') { throw new Error('No manifest data provided'); }   if (typeof(options) === 'undefined') { throw new Error('No options provided'); }   let manifest_objects = (options.useFirmata ? manifest.firmata : manifest.backpack); // this deals with a firmata object supplied that isn't the default // one in order to grab the right hex file. if (options.useFirmata && options.firmataName != '') { manifest_objects = manifest.firmata[options.firmataName]; } else if (options.useFirmata && options.firmataName == '' && manifest.firmata.multi != undefined) { // we have multiple firmatas and none have been supplied. throw new Error('Multiple firmatas are available, please supply a name'); }   if (manifest_objects.hexPath.indexOf('/') != 0) { manifest_objects.hexPath = '/' + manifest_objects.hexPath; }   const hex_path = path.join(manifest_objects.bins, options.board, manifest_objects.hexPath);   return (hex_path); }   get_manifest_from_npm(firmware) { // gets the manifest file and returns the content   if (typeof(firmware) === 'undefined') { throw new Error('No firmware details provided'); }   // as we have installed get the manifest file. const base_path = this.get_npm_basepath(firmware); const manifest_file = path.join(base_path, 'manifest.json'); let manifest = null;   try { manifest = JSON.parse(fs.readFileSync(manifest_file)); } catch (e) { throw new Error('Manifest file incorrect'); }   return manifest; }   get_npm_basepath(firmware) { // returns the base path of the folder when using npm installs if (typeof(firmware) === 'undefined') { throw new Error('No firmware details provided'); }   if (typeof(firmware.npm.package) === 'undefined') { throw new Error('No npm package provided'); }   return path.join('.', 'node_modules', firmware.npm.package); }   async get_file_from_github(uri) { // gets the manifest file from github and returns it. return await axios.get(uri) .then((response) => { Eif (response.status == '200') { // got the data return response.data; } }) .catch(err => { throw new Error('Unable to retrieve file') }); }   normalise_gh_repo_path(repo_uri) { // takes a github repo path and make sure it's in the right form to be // able to download files from it. IE removes the .git off the end. // returns a string.   let repo_str = repo_uri; if (repo_str.endsWith('/')) { repo_str = repo_str.substring(0, repo_str.length -1); }   if (repo_str.endsWith('.git')) { repo_str = repo_str.substring(0, repo_str.length - 4); }   return repo_str; }   download_from_github(firmware, options) { // downloads the file from github and returns the path to the hex file // as well as the temp directory it exists in to clean it up let base_uri = null; return new Promise((resolve, reject) => { // need to try and reolve this async out // setup GH   if (firmware === undefined) { reject(new Error('No firmware provided')); }   /* istanbul ignore next */ if (!process.env.TEST) { console.info(colors.magenta(`Installing ${firmware.name} from github`)); } // work out where the manifest file is if (firmware.repo === undefined) { reject(new Error('No github repo specified')); }   let manifest_uri = null; let branch = 'master'; let repo = '';   // console.log(firmware); if (firmware.repo.indexOf('git+https') == 0) { if (firmware.repo.indexOf('#') > 0 ) { // we want a branch so get that out of the URL branch = '/' + firmware.repo.substring(firmware.repo.indexOf('#') + 1); repo = firmware.repo.substring(22, firmware.repo.indexOf('#')); } else { repo = firmware.repo.substring(22); branch = '/master'; }   repo = this.normalise_gh_repo_path(repo); base_uri = `https://raw.githubusercontent.com${repo}${branch}`; manifest_uri = `${base_uri}/manifest.json?${(new Date().getTime())}`; } else { reject(new Error('Wrong protocol used for github')); }   this.get_file_from_github(manifest_uri) .then((manifest) => resolve(manifest)) .catch(err => reject(err)); }).then((manifest) => { // now we process the manifest file, download the hex binary and then // save it and return a path to it. const bin_path = this.get_path_from_manifest(manifest, options); const bin_uri = `${base_uri}${bin_path}?${(new Date().getTime())}`;   // save the hex file return this.get_file_from_github(bin_uri) .then(hexdata => { const tmpdir = tmp.dirSync(); const hexpath = `${tmpdir.name}/bin.hex`;   // turn the write file into a promise. const writeFile = util.promisify(fs.writeFile);   // now write the file back. return writeFile(hexpath, hexdata) .then(() => { return {hexpath, tmpdir}; }) .catch(err => { fsextra.removeSync(tmpdir.name); tmpdir.removeCallback(); throw err; }); }) .catch(err => { throw err; }); }); }   download_from_npm(firmware, options) { // downloads the file from npm and returns the path to the hex file. return new Promise((resolve, reject) => { // Set up NPM. /* istanbul ignore next */ if (!process.env.TEST) { console.info(colors.magenta('Installing ' + firmware.name + ' from npm')); }   // first try to install the npm package let command = 'npm install --no-save ';   // test to see if installing from a gh repo as an npm package. if (firmware.npm.repo !== undefined) { command = command + firmware.npm.repo; } else { if (typeof(firmware.npm.version) == 'undefined') { // just use "latest" from npm command = command + firmware.npm.package; } else { command = command + firmware.npm.package + '@' + firmware.npm.version; } }   try { // simply call the command on the command line. child_process.execSync(command, {stdio: [0,1,2]}); } catch (e) { reject(e); }   const manifest = this.get_manifest_from_npm(firmware, options);   let hexpath; try { hexpath = path.join( this.get_npm_basepath(firmware), this.get_path_from_manifest(manifest, options) ); } catch (e) { reject(new Error('Cannot get path to hex file', e)); }   resolve({hexpath}); }); }   download(firmware, options) { // manages the download of the firmware return new Promise((resolve, reject) => { // check and see if firmware is specified Eif (typeof(firmware) === 'undefined') { // set it to the constructor value firmware = this.fw; }   // if we're still undefined then throw an error. if (typeof(firmware) === 'undefined') { const err = new Error('There is no firmware supplied'); reject(err); }   // now we choose what way to download the file // now check if the firmware is in npm or github. let downloader_to_use; if (firmware.npm == undefined) { // use git repo downloader_to_use = this.download_from_github.bind(this); } else { // get from npm now downloader_to_use = this.download_from_npm.bind(this); }   downloader_to_use(firmware, options) .then((values) => { resolve(values); }) .catch(err => reject(err)); }); } }   module.exports = Downloader;  </pre></td></tr></table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Jan 26 2021 12:18:26 GMT+1100 (Australian Eastern Daylight Time) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { prettyPrint(); }; </script> <script src="../sorter.js"></script> <script src="../block-navigation.js"></script> </body> </html>