Scx1332/goth test

.github/workflows/examples-nightly.yml

@@ -0,0 +1,101 @@
+name: Nightly Examples Tests
+
+on:
+  schedule:
+    # run this workflow every day at 2:00 AM UTC
+    - cron: "0 4 * * *"
+
+  # Allows triggering the workflow manually
+  workflow_dispatch:
+
+  push:
+    branches:
+      - "test/JST-363/example-tests"
+
+jobs:
+  prepare-matrix-master-only:
+    name: Prepare matrix JSON
+    runs-on: ubuntu-latest
+    outputs:
+      matrix-json: ${{ steps.get-matrix.outputs.matrix }}
+    steps:
+      # prepares JSON object representing strategy matrix with only the master branch
+      - name: Get matrix JSON
+        id: get-matrix
+        run: echo "::set-output name=matrix::{\"include\":[{\"branch\":\"master\"}]}"
+
+  goth-tests:
+    runs-on: goth
+    needs: prepare-matrix-master-only
+    strategy:
+      matrix: ${{ fromJson(needs.prepare-matrix-master-only.outputs.matrix-json) }}
+      fail-fast: false
+    name: Run example tests (nightly) on ${{ matrix.branch }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Configure node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Build golem-js
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y build-essential
+          npm install
+          npm run build
+          npm install --prefix examples
+          npm install ts-node
+
+      - name: Configure python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install goth
+        run: |
+          pip install goth>=0.15.3
+          rm -rf ../goth/assets
+          python -m goth create-assets ../goth/assets
+          sed -Ezi 's/(use\-proxy:\s)(True)/\1False/mg' ../goth/assets/goth-config.yml
+          sed -Ezi 's/(use\-prerelease:\s)(false)/\1true\n    release-tag: "0.13.0-rc21"/mg' ../goth/assets/goth-config.yml
+          sed -i '/^ENTRYPOINT/i ENV YAGNA_AUTOCONF_APPKEY=try_golem' ../goth/assets/docker/yagna-goth-deb.Dockerfile
+
+      - name: Disconnect Docker containers from default network
+        continue-on-error: true
+        # related to this issue: https://github.com/moby/moby/issues/23302
+        run: |
+          docker network inspect docker_default
+          sudo apt-get install -y jq
+          docker network inspect docker_default | jq ".[0].Containers | map(.Name)[]" | tee /dev/stderr | xargs --max-args 1 -- docker network disconnect -f docker_default
+
+      - name: Remove Docker containers
+        continue-on-error: true
+        run: docker rm -f $(docker ps -a -q)
+
+      - name: Restart Docker daemon
+        # related to this issue: https://github.com/moby/moby/issues/23302
+        run: sudo systemctl restart docker
+
+      - name: Log in to GitHub Docker repository
+        run: echo ${{ secrets.GITHUB_TOKEN }} | docker login docker.pkg.github.com -u ${{github.actor}} --password-stdin
+
+      - name: Run test suite
+        env:
+          GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npm run test:examples
+
+      - name: Upload test logs
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: goth-logs
+          path: /tmp/goth-tests
+
+      # Only relevant for self-hosted runners
+      - name: Remove test logs
+        if: always()
+        run: rm -rf /tmp/goth-tests

.github/workflows/release.yml

@@ -161,6 +161,26 @@ jobs:
         run: rm -rf .cypress
       #endregion
 
+      #region Examples test execution
+      - name: Run the Examples tests using Goth
+        env:
+          GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npm run test:examples
+
+      - name: Upload test logs
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: goth-logs
+          path: /tmp/goth-tests
+
+      # Only relevant for self-hosted runners
+      - name: Remove test logs
+        if: always()
+        run: rm -rf /tmp/goth-tests
+      #endregion
+
   release:
     name: Release the SDK to NPM and GitHub
     needs: run-integration-and-e2e-tests

examples/docs-examples/examples/composing-tasks/batch-end.mjs

@@ -0,0 +1,24 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => {
+    const res = await ctx
+      .beginBatch()
+      .uploadFile("./worker.mjs", "/golem/input/worker.mjs")
+      .run("node /golem/input/worker.mjs > /golem/input/output.txt")
+      .run("cat /golem/input/output.txt")
+      .downloadFile("/golem/input/output.txt", "./output.txt")
+      .end()
+      .catch((error) => console.error(error)); // to be removed and replaced with try & catch
+
+    return res[2]?.stdout;
+  });
+
+  console.log(result);
+  await executor.end();
+})();

examples/docs-examples/examples/composing-tasks/batch-endstream-chunks.mjs

@@ -0,0 +1,22 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => {
+    const res = await ctx
+      .beginBatch()
+      .uploadFile("./worker.mjs", "/golem/input/worker.mjs")
+      .run("node /golem/input/worker.mjs > /golem/input/output.txt")
+      .run("cat /golem/input/output.txt")
+      .downloadFile("/golem/input/output.txt", "./output.txt")
+      .endStream();
+
+    res.on("data", (data) => (data.index == 2 ? console.log(data.stdout) : ""));
+    res.on("error", (error) => console.error(error));
+    res.on("close", () => executor.end());
+  });
+})();

examples/docs-examples/examples/composing-tasks/batch-endstream-forawait.mjs

@@ -0,0 +1,24 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => {
+    const res = await ctx
+      .beginBatch()
+      .uploadFile("./worker.mjs", "/golem/input/worker.mjs")
+      .run("node /golem/input/worker.mjs > /golem/input/output.txt")
+      .run("cat /golem/input/output.txt")
+      .downloadFile("/golem/input/output.txt", "./output.txt")
+      .endStream();
+
+    for await (const chunk of res) {
+      console.log(chunk.stdout);
+    }
+  });
+
+  await executor.end();
+})();

examples/docs-examples/examples/composing-tasks/multiple-run-prosaic.mjs

@@ -0,0 +1,20 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => {
+    await ctx.uploadFile("./worker.mjs", "/golem/input/worker.mjs");
+    await ctx.run("node /golem/input/worker.mjs > /golem/input/output.txt");
+    const result = await ctx.run("cat /golem/input/output.txt");
+    await ctx.downloadFile("/golem/input/output.txt", "./output.txt");
+    return result.stdout;
+  });
+
+  console.log(result);
+
+  await executor.end();
+})();

examples/docs-examples/examples/composing-tasks/single-command.cjs

@@ -0,0 +1,13 @@
+const { TaskExecutor } = require("@golem-sdk/golem-js");
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
+  await executor.end();
+
+  console.log("Task result:", result);
+})();

examples/docs-examples/examples/composing-tasks/single-command.mjs

@@ -0,0 +1,13 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
+  await executor.end();
+
+  console.log("Task result:", result);
+})();

examples/docs-examples/examples/composing-tasks/single-command.ts

@@ -0,0 +1,13 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run<string | unknown>(async (ctx) => (await ctx.run("node -v")).stdout);
+  await executor.end();
+
+  console.log("Task result:", result);
+})();

examples/docs-examples/examples/composing-tasks/worker.mjs

@@ -0,0 +1 @@
+console.log("Hello World");

examples/docs-examples/examples/executing-tasks/action_log.txt

@@ -0,0 +1 @@
+some action log

examples/docs-examples/examples/executing-tasks/before-each.mjs

@@ -0,0 +1,24 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+    maxParallelTasks: 3,
+  });
+
+  executor.beforeEach(async (ctx) => {
+    console.log(ctx.provider.name + " is downloading action_log file");
+    await ctx.uploadFile("./action_log.txt", "/golem/input/action_log.txt");
+  });
+
+  await executor.forEach([1, 2, 3, 4, 5], async (ctx, item) => {
+    await ctx
+      .beginBatch()
+      .run(`echo ` + `'processing item: ` + item + `' >> /golem/input/action_log.txt`)
+      .downloadFile("/golem/input/action_log.txt", "./output_" + ctx.provider.name + ".txt")
+      .end();
+  });
+
+  await executor.end();
+})();

examples/docs-examples/examples/executing-tasks/foreach.mjs

@@ -0,0 +1,16 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const data = [1, 2, 3, 4, 5];
+
+  await executor.forEach(data, async (ctx, item) => {
+    console.log((await ctx.run(`echo "${item}"`)).stdout);
+  });
+
+  await executor.end();
+})();

examples/docs-examples/examples/executing-tasks/map.mjs

@@ -0,0 +1,16 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const data = [1, 2, 3, 4, 5];
+
+  const results = executor.map(data, (ctx, item) => ctx.run(`echo "${item}"`));
+
+  for await (const result of results) console.log(result.stdout);
+
+  await executor.end();
+})();

examples/docs-examples/examples/executing-tasks/max-parallel-tasks.mjs

@@ -0,0 +1,17 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+    maxParallelTasks: 3, // default is 5
+  });
+
+  const data = [1, 2, 3, 4, 5];
+
+  const results = executor.map(data, (ctx, item) => ctx.run(`echo "${item}"`));
+
+  for await (const result of results) console.log(result.stdout);
+
+  await executor.end();
+})();

examples/docs-examples/examples/executing-tasks/single-run.mjs

@@ -0,0 +1,14 @@
+import { TaskExecutor } from "@golem-sdk/golem-js";
+
+(async () => {
+  const executor = await TaskExecutor.create({
+    package: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+    yagnaOptions: { apiKey: "try_golem" },
+  });
+
+  const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
+
+  await executor.end();
+
+  console.log("Task result:", result);
+})();