feat: add setAgoraKey task and corresponding tests for API key management

Author: luisvid

packages/ethernaut-optigov/src/tasks/setAgoraKey.js

@@ -0,0 +1,34 @@
+const types = require('ethernaut-common/src/validation/types')
+const output = require('ethernaut-common/src/ui/output')
+const storage = require('ethernaut-common/src/io/storage')
+const { setEnvVar } = require('ethernaut-common/src/io/env')
+
+require('../scopes/optigov')
+  .task('agorakey', 'Sets the Agora API Key')
+  .addParam('apiKey', 'The Agora API Key to use', undefined, types.string)
+  .setAction(async ({ apiKey }, _hre) => {
+    try {
+      const config = storage.readConfig()
+
+      let summary = []
+
+      if (apiKey) {
+        const currentKey = process.env.AGORA_API_KEY
+        setEnvVar('AGORA_API_KEY', apiKey)
+        summary.push(`- Agora API Key set to ${apiKey} (was ${currentKey})`)
+        summary.push(
+          'Please restart the tool for the new API key to take effect.',
+        )
+      }
+
+      storage.saveConfig(config)
+
+      if (summary.length === 0) {
+        summary.push('No changes')
+      }
+
+      return output.resultBox(summary.join('\n'))
+    } catch (err) {
+      return output.errorBox(err)
+    }
+  })

packages/ethernaut-optigov/test/tasks/setAgoraKey.test.js

@@ -0,0 +1,52 @@
+const assert = require('assert')
+const hre = require('hardhat')
+const storage = require('ethernaut-common/src/io/storage')
+const { setEnvVar } = require('ethernaut-common/src/io/env')
+
+describe('setAgoraKey task', function () {
+  let originalEnv, originalSetEnvVar, originalSaveConfig, originalReadConfig
+
+  beforeEach(function () {
+    // Save original environment variable value
+    originalEnv = process.env.AGORA_API_KEY
+
+    // Stub setEnvVar to immediately update process.env
+    originalSetEnvVar = setEnvVar
+    require('ethernaut-common/src/io/env').setEnvVar = (key, value) => {
+      process.env[key] = value
+    }
+
+    // Stub storage functions to prevent file I/O
+    originalSaveConfig = storage.saveConfig
+    originalReadConfig = storage.readConfig
+    storage.saveConfig = () => {} // no-op
+    storage.readConfig = () => ({})
+  })
+
+  afterEach(function () {
+    // Restore original environment variable and function references
+    process.env.AGORA_API_KEY = originalEnv
+    require('ethernaut-common/src/io/env').setEnvVar = originalSetEnvVar
+    storage.saveConfig = originalSaveConfig
+    storage.readConfig = originalReadConfig
+  })
+
+  it('should set the Agora API Key and instruct to restart', async function () {
+    const testKey = 'TEST_API_KEY'
+
+    const result = await hre.run(
+      { scope: 'optigov', task: 'agorakey' },
+      { apiKey: testKey },
+    )
+
+    // Verify the output contains the new key and the restart message.
+    assert(result.includes(`- Agora API Key set to ${testKey}`))
+    assert(
+      result.includes(
+        'Please restart the tool for the new API key to take effect.',
+      ),
+    )
+    // Also verify process.env was updated
+    assert.strictEqual(process.env.AGORA_API_KEY, testKey)
+  })
+})