unit tests

Author: Piotr Węgrzyn

.github/workflows/linter_eth.yml renamed to .github/workflows/eth_linter.yml

@@ -8,8 +8,9 @@ on:
 jobs:
   analyze:
     runs-on: ubuntu-latest
+    name: A job to run linter
     steps:
-    - name: Checkout repository
+    - name: Checkout
       uses: actions/checkout@v4
     - name: Linter analysis with Slither
       uses: crytic/slither-action@v0.4.0

.github/workflows/eth_unit_tests.yml

@@ -0,0 +1,23 @@
+name: Unit tests for Cyrograf ETH
+
+on:
+  pull_request:
+    branches: [ master ]
+    paths: [ 'eth/**' ]
+
+jobs:
+  unit_tests:
+    runs-on: ubuntu-latest
+    name: A job to run sample solidity tests
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Environment Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14.17.6
+      - name: Run SUT action with default provider
+        uses: EthereumRemix/sol-test@v1.2
+        with:
+          test-path: 'eth/tests/'
+          compiler-version: '0.8.26'

.github/workflows/deploy_ui.yml renamed to .github/workflows/ui_deploy.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Pin and publish
     steps:
-    - name: Checkout repository
+    - name: Checkout
       uses: actions/checkout@v4
     - name: IPFS Pin & Publish
       id: IPFS

.gitignore

@@ -1,3 +1,4 @@
 .vscode/
 **/.states/
-**/artifacts/
+**/artifacts/
+**/.deps/

eth/tests/cyrograf_test.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+        
+pragma solidity >=0.8.26;
+
+import "remix_tests.sol"; 
+import "remix_accounts.sol";
+import "../cyrograf.sol";
+
+contract CyrografTestSuite {
+    Cyrograf cyrograf;
+
+    // Setup function to initialize the contract before tests run
+    function beforeEach() public {
+        cyrograf = new Cyrograf();
+    }
+
+    function testInitialBackground() public {
+        Cyrograf.Background memory got = cyrograf.getBackground();
+
+        Assert.equal(got.author, address(this), "The author should be the deployer");
+
+        Assert.equal(got.topLeft.x, uint8(0), "Top left X should be 0");
+        Assert.equal(got.topLeft.y, uint8(0), "Top left Y should be 0");
+        Assert.equal(got.topLeft.z, uint8(0), "Top left Z should be 0");
+
+        Assert.equal(got.topRight.x, uint8(255), "Top right X should be 255");
+        Assert.equal(got.topRight.y, uint8(255), "Top right Y should be 255");
+        Assert.equal(got.topRight.z, uint8(255), "Top right Z should be 255");
+    }
+
+    function testSetAndGetBackground() public {
+        cyrograf.setBackground(Cyrograf.RGB(128, 64, 32), Cyrograf.RGB(200, 150, 100));
+
+        Cyrograf.Background memory got = cyrograf.getBackground();
+
+        Assert.equal(got.author, address(this), "The author should be the caller");
+
+        Assert.equal(got.topLeft.x, uint8(128), "North west X should be updated");
+        Assert.equal(got.topLeft.y, uint8(64), "North west Y should be updated");
+        Assert.equal(got.topLeft.z, uint8(32), "North west Z should be updated");
+
+        Assert.equal(got.topRight.x, uint8(200), "South east X should be updated");
+        Assert.equal(got.topRight.y, uint8(150), "South east Y should be updated");
+        Assert.equal(got.topRight.z, uint8(100), "South east Z should be updated");
+    }
+}
+