test(defined): create tests for defined() (#7967)

Co-authored-by: Stephane MEYER <[email protected]>
Co-authored-by: Julien Fontanet <[email protected]>

@xen-orchestra/defined/.USAGE.md

@@ -0,0 +1,29 @@
+### `defined()`
+
+Returns the first non-`undefined` value from a list of arguments, evaluating functions if needed.
+
+There is two ways to use this function:
+
+- either with a single array argument: it should return the first non-undefined item
+- or with multiple arguments: it should return the first non-undefined argument
+
+If only `undefined` values, return `undefined`.
+
+```js
+import defined from '@xen-orchestra/defined/index.js'
+
+defined(undefined, 'foo', 42)
+// Returns 'foo'
+
+defined([undefined, null, 10])
+// Returns null
+
+defined([undefined, undefined], [undefined, undefined, 10])
+// Returns [undefined, undefined]
+
+defined(() => 'bar', 42)
+// Returns 'bar'
+
+defined(undefined, undefined)
+// Returns undefined
+```

@xen-orchestra/defined/README.md

@@ -14,6 +14,37 @@ Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/defin
 npm install --save @xen-orchestra/defined
 ```
 
+## Usage
+
+### `defined()`
+
+Returns the first non-`undefined` value from a list of arguments, evaluating functions if needed.
+
+There is two ways to use this function:
+- either with a single array argument: it should return the first non-undefined item
+- or with multiple arguments: it should return the first non-undefined argument
+
+If only `undefined` values, return `undefined`.
+
+```js
+import defined from '@xen-orchestra/defined/index.js'
+
+defined(undefined, 'foo', 42)
+// Returns 'foo'
+
+defined([undefined, null, 10])
+// Returns null
+
+defined([undefined, undefined], [undefined, undefined, 10])
+// Returns [undefined, undefined]
+
+defined(() => 'bar', 42)
+// Returns 'bar'
+
+defined(undefined, undefined)
+// Returns undefined
+```
+
 ## Contributions
 
 Contributions are _very_ welcomed, either on the documentation or on

@xen-orchestra/defined/index.js

@@ -22,7 +22,7 @@ function defined() {
   }
 
   for (let i = 0; i < n; ++i) {
-    let arg = arguments[i]
+    let arg = args[i]
     if (typeof arg === 'function') {
       arg = get(arg)
     }

@xen-orchestra/defined/index.test.mjs

@@ -0,0 +1,30 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import defined_ from '@xen-orchestra/defined/index.js'
+
+// for each test, use the flat syntax and the array syntax
+for (const [title, defined] of Object.entries({
+  'defined(...values)': defined_,
+  'defined([ ...values ])': (...args) => defined_(args),
+})) {
+  describe(title, () => {
+    it('returns the first non undefined value', () => {
+      assert.deepEqual(defined(undefined, 'foo', 42), 'foo')
+    })
+
+    it('returns undefined if only undefined values', () => {
+      assert.equal(defined(undefined, undefined), undefined)
+    })
+
+    it('resolves functions with `get(fn)`', () => {
+      const o = { foo: undefined, baz: 'baz' }
+      assert.deepEqual(
+        defined(
+          () => o.foo.bar,
+          () => o.baz
+        ),
+        'baz'
+      )
+    })
+  })
+}

@xen-orchestra/defined/package.json

@@ -23,6 +23,7 @@
     "node": ">=6"
   },
   "scripts": {
-    "postversion": "npm publish"
+    "postversion": "npm publish",
+    "test": "node --test"
   }
 }

CHANGELOG.unreleased.md

@@ -41,6 +41,7 @@
 
 <!--packages-start-->
 
+- @xen-orchestra/defined patch
 - @xen-orchestra/lite minor
 - @xen-orchestra/web minor
 - @xen-orchestra/web-core minor