integrate ESP32 E2E CI workflow

Author: marcelkottmann

.github/workflows/ci.yml

@@ -3,11 +3,43 @@ on: [push]
 jobs:
   build:
     runs-on: ubuntu-latest
-    timeout-minutes: 5
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v1
       - name: Build
         run: |
           docker build  -t esp32-javascript:latest -f tools/Dockerfile .
-          docker run -t esp32-javascript:latest bash -c '. ./tools/install-node.sh; idf.py build'
+          docker run --name esp32-javascript-build -t esp32-javascript:latest bash -c './tools/build.sh'
+          docker cp 'esp32-javascript-build:/opt/esp32-javascript/build.tar.gz' .
+          docker cp 'esp32-javascript-build:/opt/esp32-javascript/self-test-build.tar.gz' .
+      - name: Extract self test build output
+        run: tar xvzf self-test-build.tar.gz
+      - name: Create Session
+        run: echo SESSION=$(curl --silent -X POST https://api.e2e.kottmann.rocks/session | jq -r .id) >> $GITHUB_ENV
+      - name: Flash artifacts to test device
+        run: curl --silent -F session=${{ env.SESSION }} -F follow=true -F offset=0x1000 -F bin=@build/bootloader/bootloader.bin -F offset=0x8000 -F bin=@build/partition_table/partition-table.bin -F offset=0x10000 -F bin=@build/esp32-javascript.bin -F offset=0x3c0000 -F bin=@build/modules.bin https://api.e2e.kottmann.rocks/flash
+      - name: Wait for startup
+        run: curl --silent -F session=${{ env.SESSION }} -F 'find=Self test initialized.' https://api.e2e.kottmann.rocks/monitor | jq -e .match
+      - name: Check Setup page
+        run: curl --silent https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/setup | grep '<h1>Setup</h1>'
+      - name: Self Test Pins
+        run: |
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/18/0
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO18 == false'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/18/1
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO18'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/19/0
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO19 == false'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/19/1
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO19'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/21/0
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO21 == false'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/21/1
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO21'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/22/0
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO22 == false'
+          curl https://esp32:esp32@${{ env.SESSION }}.e2e.kottmann.rocks/selftest/pins/22/1
+          curl --silent -X POST -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/snapshot | jq -e '.GPIO22'
+      - name: Cleanup
+        run: curl --silent -F session=${{ env.SESSION }} https://api.e2e.kottmann.rocks/release

.gitignore

@@ -3,4 +3,3 @@ sdkconfig.old*
 main/project.cpp
 main/project.c
 node_modules
-

README.md

@@ -4,9 +4,10 @@
 
 "Lightweight" JS interpreter for ESP32. Provides JS-based eventloop implementation
 and native asynchronous network and timer functions.
-Because of the limited memory on ESP32-WROOM modules, the full functionality is currently only realizable on ESP32-WROVER modules, that include additional 4MB of SPIRAM memory.   
+Because of the limited memory on ESP32-WROOM modules, the full functionality is currently only realizable on ESP32-WROVER modules, that include additional 4MB of SPIRAM memory.
 
 ## Content
+
 [Getting started](#getting-started)
 
 [API](#api)
@@ -16,28 +17,34 @@ Because of the limited memory on ESP32-WROOM modules, the full functionality is
 ## Getting started
 
 ### Prerequisites
-Install [esp-idf](http://esp-idf.readthedocs.io/en/latest/get-started/index.html#setup-toolchain) on your system.
+
+Install [esp-idf 4.2](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/index.html) on your system.
 
 ### First install
+
 Clone esp32-javascript inside your esp directory (normally ~/esp):
+
 ```shell
     cd ~/esp
     git clone https://github.com/pepe79/esp32-javascript.git
 ```
 
 Change into ~/esp/esp32-javascript.
+
 ```shell
     cd ~/esp/esp32-javascript
 ```
 
 Maybe you want to change the BOARD_VARIANT in the ./CMakeLists.txt file.
 
 First build the project with
+
 ```shell
     idf.py build
 ```
 
 Connect your ESP32 Dev Board via USB and run
+
 ```shell
     idf.py flash monitor
 ```
@@ -46,15 +53,16 @@ Use the keyboard shortcut `AltGr + ]` to leave serial monitor.
 
 Now you have installed the pre-configured boot script.
 
-If this is your first install, your onboard LED should blink now. Blinking signals that your board has started a soft ap with the ssid "esp32". With your mobile or desktop connect to the WLAN SSID "esp32" and open http://192.168.4.1/setup (if you have not changed the default credentials your username / password is esp32 / esp32 ). You can change the default password in `./sdkconfig` by changing the value of `CONFIG_ESP32_JS_BASIC_AUTH_PASSWORD`.  
+If this is your first install, your onboard LED should blink now. Blinking signals that your board has started a soft ap with the ssid "esp32". With your mobile or desktop connect to the WLAN SSID "esp32" and open http://192.168.4.1/setup (if you have not changed the default credentials your username / password is esp32 / esp32 ). You can change the default password in
+[firmware-config.ts](./components/esp32-javascript/modules/esp32-javascript/firmware-config.ts) by changing the value of key`password`.
 
 On the Setup page you can configure your WLAN settings and an URL to download your JS main script from.
 
-Please note that the script, does not need to have a main function, because its evaluated entirely. 
+Please note that the script, does not need to have a main function, because its evaluated entirely.
 That means, to print out "Hello World", you only have to include one line in your script on the webserver:
 
 ```js
-    console.log('Hello world!');
+console.log("Hello world!");
 ```
 
 ### C/C++bindings
@@ -63,6 +71,7 @@ If you need to create your own C/C++ bindings for your JS code, this are the ste
 
 1. Create a file named `project.cpp` in the `./main` directory
 2. Implement the esp32_javascript_main callback function inside this `project.ccp`:
+
 ```c
    #include "esp32-javascript.h"
 
@@ -78,15 +87,15 @@ If you need more than this, you can create your own esp-idf component below `./c
 Additionally you have to set your component name in the top level `./CMakeLists.txt`. Refer to the documentation next to the setting `ESP32_JS_PROJECT_NAME`.
 See [ESP Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) for information on how to create a component with the esp-idf build system.
 
-### Clean        
+### Clean
 
 You can clean the project by executing
 
 ```shell
     idf.py fullclean
 ```
 
-### Factory reset        
+### Factory reset
 
 You can erase the persistent flash memory, which will be equivalent to a factory reset, by executing
 
@@ -96,9 +105,10 @@ You can erase the persistent flash memory, which will be equivalent to a factory
 
 ## Compatibility
 
-Tested with esp-idf (master branch commit hash 2e14149b).
+Tested with esp-idf [release/v4.2](https://github.com/espressif/esp-idf/tree/release/v4.2)
 
 ## API
+
 [API documentation](docs/README.md)
 
 ### Update docs
@@ -110,4 +120,5 @@ Update documentation by executing
 ```
 
 ## License
+
 See source files.

components/esp32-javascript/Kconfig

@@ -517,17 +517,6 @@ void loadUrlPolyfill(duk_context *ctx)
     loadJS(ctx, "urlparse.js", _start, _end);
 }
 
-duk_ret_t getFirmwareDefaults(duk_context *ctx)
-{
-    duk_idx_t obj_idx = duk_push_object(ctx);
-
-    duk_push_string(ctx, CONFIG_ESP32_JS_BASIC_AUTH_USERNAME);
-    duk_put_prop_string(ctx, obj_idx, "basicAuthUsername");
-    duk_push_string(ctx, CONFIG_ESP32_JS_BASIC_AUTH_PASSWORD);
-    duk_put_prop_string(ctx, obj_idx, "basicAuthPassword");
-    return 1;
-}
-
 duk_ret_t btoa(duk_context *ctx)
 {
     const char *str = duk_to_string(ctx, 0);
@@ -704,9 +693,6 @@ void duktape_task(void *ignore)
     duk_push_c_function(ctx, setDateTimeZoneOffsetInHours, 1 /*nargs*/);
     duk_put_global_string(ctx, "setDateTimeZoneOffsetInHours");
 
-    duk_push_c_function(ctx, getFirmwareDefaults, 0 /*nargs*/);
-    duk_put_global_string(ctx, "getFirmwareDefaults");
-
     duk_push_c_function(ctx, btoa, 1 /*nargs*/);
     duk_put_global_string(ctx, "btoa");
 

components/esp32-javascript/esp32-javascript.c

@@ -1,18 +1,16 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.saveConfig = exports.reloadConfig = exports.config = void 0;
+var firmware_config_1 = __importDefault(require("./firmware-config"));
 var CONFIG_PATH = "/data/config.js";
 function reloadConfig() {
     try {
         exports.config = JSON.parse(readFile(CONFIG_PATH));
     }
     catch (error) {
-        var dc = getFirmwareDefaults();
-        exports.config = {
-            access: {
-                username: dc.basicAuthUsername,
-                password: dc.basicAuthPassword,
-            },
-        };
+        exports.config = firmware_config_1.default;
         console.error("An error ocurred while accessing config. Maybe it does not exist.");
     }
 }

components/esp32-javascript/modules/esp32-javascript/config.js

@@ -1,4 +1,5 @@
-interface Esp32JsConfig {
+import firmwareConfig from "./firmware-config";
+export interface Esp32JsConfig {
   access: {
     username: string;
     password: string;
@@ -22,13 +23,7 @@ export function reloadConfig(): void {
   try {
     config = JSON.parse(readFile(CONFIG_PATH));
   } catch (error) {
-    const dc = getFirmwareDefaults();
-    config = {
-      access: {
-        username: dc.basicAuthUsername,
-        password: dc.basicAuthPassword,
-      },
-    };
+    config = firmwareConfig;
     console.error(
       "An error ocurred while accessing config. Maybe it does not exist."
     );

components/esp32-javascript/modules/esp32-javascript/config.ts

@@ -22,7 +22,6 @@ interface Esp32JsFirmwareDefaults {
   basicAuthPassword: string;
 }
 
-declare function getFirmwareDefaults(): Esp32JsFirmwareDefaults;
 declare function restart(): void;
 
 interface Esp32JsEventloopEvent {

components/esp32-javascript/modules/esp32-javascript/esp32-javascript.d.ts

@@ -0,0 +1,8 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+var firmwareConfig = {
+    access: {
+        username: "esp32",
+        password: "esp32",
+    },
+};
+exports.default = firmwareConfig;

components/esp32-javascript/modules/esp32-javascript/firmware-config.js

@@ -0,0 +1,10 @@
+import { Esp32JsConfig } from "./config";
+
+const firmwareConfig: Esp32JsConfig = {
+  access: {
+    username: "esp32",
+    password: "esp32",
+  },
+};
+
+export default firmwareConfig;