From 3445164e2d9042189f79f76568a548d4e7ff9a81 Mon Sep 17 00:00:00 2001
From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com>
Date: Mon, 7 Oct 2024 09:56:41 -0300
Subject: [PATCH] test(psram): Add PSRAM test (#10409)

* test(psram): Add PSRAM test

* fix(test): Hide pointer arithmetic warning

* ci(pre-commit): Apply automatic fixes

* fix(json): Remove FQBNs for the test

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
---
 tests/validation/psram/ci.json       |  14 ++++
 tests/validation/psram/psram.ino     | 112 +++++++++++++++++++++++++++
 tests/validation/psram/test_psram.py |   2 +
 3 files changed, 128 insertions(+)
 create mode 100644 tests/validation/psram/ci.json
 create mode 100644 tests/validation/psram/psram.ino
 create mode 100644 tests/validation/psram/test_psram.py

diff --git a/tests/validation/psram/ci.json b/tests/validation/psram/ci.json
new file mode 100644
index 00000000000..fc34574cf37
--- /dev/null
+++ b/tests/validation/psram/ci.json
@@ -0,0 +1,14 @@
+{
+  "platforms": {
+    "qemu": false,
+    "wokwi": false
+  },
+  "requires": [
+    "CONFIG_SPIRAM=y"
+  ],
+  "targets": {
+    "esp32c3": false,
+    "esp32c6": false,
+    "esp32h2": false
+  }
+}
diff --git a/tests/validation/psram/psram.ino b/tests/validation/psram/psram.ino
new file mode 100644
index 00000000000..1304fe85cc1
--- /dev/null
+++ b/tests/validation/psram/psram.ino
@@ -0,0 +1,112 @@
+#include <Arduino.h>
+#include <unity.h>
+
+#define MAX_TEST_SIZE 512 * 1024  // 512KB
+
+void *buf = NULL;
+
+void test_malloc_success(void) {
+  buf = ps_malloc(MAX_TEST_SIZE);
+  TEST_ASSERT_NOT_NULL(buf);
+  free(buf);
+  buf = NULL;
+}
+
+void test_calloc_success(void) {
+  buf = ps_calloc(MAX_TEST_SIZE, 1);
+  TEST_ASSERT_NOT_NULL(buf);
+  free(buf);
+  buf = NULL;
+}
+
+void test_realloc_success(void) {
+  buf = ps_malloc(MAX_TEST_SIZE);
+  TEST_ASSERT_NOT_NULL(buf);
+  buf = ps_realloc(buf, MAX_TEST_SIZE + 1024);
+  TEST_ASSERT_NOT_NULL(buf);
+  free(buf);
+  buf = NULL;
+}
+
+void test_malloc_fail(void) {
+  buf = ps_malloc(0xFFFFFFFF);
+  TEST_ASSERT_NULL(buf);
+}
+
+void test_memset_all_zeroes(void) {
+  memset(buf, 0, MAX_TEST_SIZE);
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    TEST_ASSERT_EQUAL(0, ((uint8_t *)buf)[i]);
+  }
+}
+
+void test_memset_all_ones(void) {
+  memset(buf, 0xFF, MAX_TEST_SIZE);
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    TEST_ASSERT_EQUAL(0xFF, ((uint8_t *)buf)[i]);
+  }
+}
+
+void test_memset_alternating(void) {
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    ((uint8_t *)buf)[i] = i % 2 == 0 ? 0x00 : 0xFF;
+  }
+  memset(buf, 0xAA, MAX_TEST_SIZE);
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    TEST_ASSERT_EQUAL(0xAA, ((uint8_t *)buf)[i]);
+  }
+}
+
+void test_memset_random(void) {
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    ((uint8_t *)buf)[i] = random(0, 256);
+  }
+  memset(buf, 0x55, MAX_TEST_SIZE);
+  for (size_t i = 0; i < MAX_TEST_SIZE; i++) {
+    TEST_ASSERT_EQUAL(0x55, ((uint8_t *)buf)[i]);
+  }
+}
+
+void test_memcpy(void) {
+  void *buf2 = malloc(1024);  // 1KB
+  TEST_ASSERT_NOT_NULL(buf2);
+  memset(buf, 0x55, MAX_TEST_SIZE);
+  memset(buf2, 0xAA, 1024);
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wpointer-arith"
+
+  for (size_t i = 0; i < MAX_TEST_SIZE; i += 1024) {
+    memcpy(buf + i, buf2, 1024);
+  }
+
+  for (size_t i = 0; i < MAX_TEST_SIZE; i += 1024) {
+    TEST_ASSERT_NULL(memcmp(buf + i, buf2, 1024));
+  }
+
+#pragma GCC diagnostic pop
+
+  free(buf2);
+}
+
+void setup() {
+  Serial.begin(115200);
+  while (!Serial) {
+    delay(10);
+  }
+
+  UNITY_BEGIN();
+  RUN_TEST(test_malloc_success);
+  RUN_TEST(test_malloc_fail);
+  RUN_TEST(test_calloc_success);
+  RUN_TEST(test_realloc_success);
+  buf = ps_malloc(MAX_TEST_SIZE);
+  RUN_TEST(test_memset_all_zeroes);
+  RUN_TEST(test_memset_all_ones);
+  RUN_TEST(test_memset_alternating);
+  RUN_TEST(test_memset_random);
+  RUN_TEST(test_memcpy);
+  UNITY_END();
+}
+
+void loop() {}
diff --git a/tests/validation/psram/test_psram.py b/tests/validation/psram/test_psram.py
new file mode 100644
index 00000000000..7bd1d9d735d
--- /dev/null
+++ b/tests/validation/psram/test_psram.py
@@ -0,0 +1,2 @@
+def test_psram(dut):
+    dut.expect_unity_test_output(timeout=120)