appended: Move common.cleanseOldHexFormat() here and add tests.

Author: microbit-carlos

src/__tests__/micropython-appended.spec.ts

@@ -15,17 +15,18 @@ const simpleIntelHex: string =
   ':1000000000400020ED530100295401002B54010051\n' +
   ':00000001FF\n';
 
+const pyCode = 'from microbit import *\n' + "display.scroll('Hello, World!')";
+const pyCodeHex =
+  ':020000040003F7\n' +
+  ':10E000004D50360066726F6D206D6963726F626984\n' +
+  ':10E010007420696D706F7274202A0A646973706C61\n' +
+  ':10E0200061792E7363726F6C6C282748656C6C6F16\n' +
+  ':10E030002C20576F726C642127290000000000001B';
+
+const marker = ':::::::::::::::::::::::::::::::::::::::::::';
+
 describe('Inject Python code into Intel Hex string', () => {
   it('Inject Python code into an Intel Hex string', () => {
-    const pyCode =
-      'from microbit import *\n' + "display.scroll('Hello, World!')";
-    const pyCodeHex =
-      ':020000040003F7\n' +
-      ':10E000004D50360066726F6D206D6963726F626984\n' +
-      ':10E010007420696D706F7274202A0A646973706C61\n' +
-      ':10E0200061792E7363726F6C6C282748656C6C6F16\n' +
-      ':10E030002C20576F726C642127290000000000001B';
-
     const output: string = addIntelHexAppendedScript(simpleIntelHex, pyCode);
 
     const fullHex: string[] = simpleIntelHex.split('\n');
@@ -34,14 +35,6 @@ describe('Inject Python code into Intel Hex string', () => {
   });
 
   it('Inject Python with present UICR and Start Linear Address record', () => {
-    const pyCode: string =
-      'from microbit import *\n' + "display.scroll('Hello, World!')";
-    const pyCodeHex: string =
-      ':020000040003F7\n' +
-      ':10E000004D50360066726F6D206D6963726F626984\n' +
-      ':10E010007420696D706F7274202A0A646973706C61\n' +
-      ':10E0200061792E7363726F6C6C282748656C6C6F16\n' +
-      ':10E030002C20576F726C642127290000000000001B\n';
     const uicr: string =
       ':020000041000EA\n' +
       ':1010C0007CB0EE17FFFFFFFF0A0000000000E30006\n' +
@@ -57,10 +50,30 @@ describe('Inject Python code into Intel Hex string', () => {
 
     const expectedHex: string[] = simpleIntelHex.split('\n');
     // Note that the 05 record is removed by nrf-intel-hex library!
-    expectedHex.splice(2, 0, pyCodeHex + uicr);
+    expectedHex.splice(2, 0, pyCodeHex + '\n' + uicr);
     expect(output).toEqual(expectedHex.join('\n'));
   });
 
+  it('Inject Python in a hex with a  marker', () => {
+    const fullHexWithMarker: string[] = simpleIntelHex.split('\n');
+    fullHexWithMarker.splice(2, 0, marker);
+    const fullHexWithout: string[] = simpleIntelHex.split('\n');
+    const expectedHex: string[] = simpleIntelHex.split('\n');
+    expectedHex.splice(2, 0, pyCodeHex);
+
+    const outputWithMarker: string = addIntelHexAppendedScript(
+      fullHexWithMarker.join('\n'),
+      pyCode
+    );
+    const outputWithout: string = addIntelHexAppendedScript(
+      fullHexWithout.join('\n'),
+      pyCode
+    );
+
+    expect(outputWithMarker).toEqual(expectedHex.join('\n'));
+    expect(outputWithMarker).toEqual(outputWithout);
+  });
+
   it('Fail to inject Python code too large for flash', () => {
     const failCase = () => {
       const fakeCode: string = new Array(8 * 1024 + 2).join('a');
@@ -75,9 +88,15 @@ describe('Inject Python code into Intel Hex string', () => {
 
 describe('Extract Python code from Intel Hex string', () => {
   it('Extract Python code', () => {
-    const pyCode: string =
-      'from microbit import *\n' + "display.scroll('Hello, World!')";
-    const intelHex: string =
+    const intelHex1: string =
+      ':020000040000FA\n' +
+      ':1000000000400020ED530100295401002B54010051\n' +
+      ':020000040003F7\n' +
+      pyCodeHex +
+      '\n' +
+      ':00000001FF\n';
+    // pyCodeHex contains zeros to fill the record, this example doesn't
+    const intelHex2: string =
       ':020000040000FA\n' +
       ':1000000000400020ED530100295401002B54010051\n' +
       ':020000040003F7\n' +
@@ -87,14 +106,14 @@ describe('Extract Python code from Intel Hex string', () => {
       ':0AE030002C20576F726C6421272921\n' +
       ':00000001FF\n';
 
-    const result: string = getIntelHexAppendedScript(intelHex);
+    const result1: string = getIntelHexAppendedScript(intelHex1);
+    const result2: string = getIntelHexAppendedScript(intelHex2);
 
-    expect(result).toEqual(pyCode);
+    expect(result1).toEqual(pyCode);
+    expect(result2).toEqual(pyCode);
   });
 
   it('Extract Python code with present UICR and Start Linear Address record)', () => {
-    const pyCode: string =
-      'from microbit import *\n' + "display.scroll('Hello, World!')";
     const intelHex: string =
       ':020000040000FA\n' +
       ':1000000000400020ED530100295401002B54010051\n' +

src/common.ts

@@ -6,22 +6,6 @@
  */
 import { TextDecoderLite, TextEncoderLite } from 'text-encoder-lite';
 
-/**
- * Marker placed inside the MicroPython hex string to indicate where to
- * inject the user Python Code.
- */
-const HEX_INSERTION_POINT = ':::::::::::::::::::::::::::::::::::::::::::\n';
-
-/**
- * Removes the old insertion line the input Intel Hex string contains it.
- *
- * @param intelHex - String with the intel hex lines.
- * @returns The Intel Hex string without insertion line.
- */
-export function cleanseOldHexFormat(intelHex: string): string {
-  return intelHex.replace(HEX_INSERTION_POINT, '');
-}
-
 /**
  * Converts a string into a byte array of characters.
  * @param str - String to convert to bytes.

src/micropython-appended.ts

@@ -6,7 +6,7 @@
  */
 import MemoryMap from 'nrf-intel-hex';
 
-import { bytesToStr, cleanseOldHexFormat, strToBytes } from './common';
+import { bytesToStr, strToBytes } from './common';
 
 /** User script located at specific flash address. */
 enum AppendedBlock {
@@ -31,6 +31,22 @@ const HEADER_START_BYTE_1 = 80; // 'P'
 /** How many bytes per Intel Hex record line. */
 const HEX_RECORD_DATA_LEN = 16;
 
+/**
+ * Marker placed inside the MicroPython hex string to indicate where to
+ * inject the user Python Code.
+ */
+const HEX_INSERTION_POINT = ':::::::::::::::::::::::::::::::::::::::::::\n';
+
+/**
+ * Removes the old insertion line the input Intel Hex string contains it.
+ *
+ * @param intelHex - String with the intel hex lines.
+ * @returns The Intel Hex string without insertion line.
+ */
+export function cleanseOldHexFormat(intelHex: string): string {
+  return intelHex.replace(HEX_INSERTION_POINT, '');
+}
+
 /**
  * Parses through an Intel Hex string to find the Python code at the
  * allocated address and extracts it.

src/micropython-fs-builder.ts

@@ -33,12 +33,7 @@
  */
 import MemoryMap from 'nrf-intel-hex';
 
-import {
-  bytesToStr,
-  cleanseOldHexFormat,
-  concatUint8Array,
-  strToBytes,
-} from './common';
+import { bytesToStr, concatUint8Array, strToBytes } from './common';
 import { AppendedBlock, isAppendedScriptPresent } from './micropython-appended';
 import { getHexMapUicrData } from './uicr';
 
@@ -368,8 +363,7 @@ function addIntelHexFile(
   data: Uint8Array
 ): string {
   // filename and data checked in addMemMapFile
-  const intelHexClean = cleanseOldHexFormat(intelHex);
-  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHex);
   intelHexMap = addMemMapFile(intelHexMap, filename, data);
   return intelHexMap.asHexString() + '\n';
 }
@@ -393,8 +387,7 @@ function addIntelHexFiles(
   files: { [filename: string]: Uint8Array },
   returnBytes: boolean = false
 ): string | Uint8Array {
-  const intelHexClean = cleanseOldHexFormat(intelHex);
-  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHex);
   Object.keys(files).forEach((filename) => {
     intelHexMap = addMemMapFile(intelHexMap, filename, files[filename]);
   });
@@ -418,17 +411,16 @@ function addIntelHexFiles(
 function getIntelHexFiles(
   intelHex: string
 ): { [filename: string]: Uint8Array } {
-  const intelHexClean = cleanseOldHexFormat(intelHex);
-  const hexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  const hexMap: MemoryMap = MemoryMap.fromHex(intelHex);
   const startAddress: number = getStartAddress(hexMap);
   const endAddress: number = getLastPageAddress(hexMap);
 
   // TODO: endAddress as the getLastPageAddress works now because this
   // library uses the last page as the "persistent" page, so the filesystem does
   // end there. In reality, the persistent page could be the first or the last
   // page, so we should get the end address as the magnetometer page and then
-  // check if the persistent marker is present in the first of last page and take that
-  // into account in the memory range calculation.
+  // check if the persistent marker is present in the first of last page and
+  // take that into account in the memory range calculation.
   // Note that the persistent marker is only present at the top of the page
 
   // Iterate through the filesystem to collect used chunks and file starts
@@ -518,11 +510,10 @@ function getIntelHexFiles(
  * @returns Size of the filesystem in bytes.
  */
 function getIntelHexFsSize(intelHex: string): number {
-  const intelHexClean = cleanseOldHexFormat(intelHex);
-  const intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  const intelHexMap: MemoryMap = MemoryMap.fromHex(intelHex);
   const startAddress: number = getStartAddress(intelHexMap);
   const endAddress = getEndAddress(intelHexMap);
-  // Remember that one page is used as persistent page
+  // One extra page is used as persistent page
   return endAddress - startAddress - FLASH_PAGE_SIZE;
 }