w-orm-reladb 1.1.12 → 1.1.14

package/test/api-lower-cases.mjs

@@ -0,0 +1,129 @@
+import assert from 'assert'
+import wo from '../src/WOrmReladb.mjs'
+import lowerCases from 'wsemi/src/_lowerFindCases.mjs'
+
+
+//本檔為mssql與sqlite共用之wsemi契約案例表_lowerFindCases(方言中立條件IR之契約表, 85案)測試套組(CLAUDE_rulebook.md之R15), 由api-sqlite.test.mjs與api-mssql.test.mjs引入
+//本套件不採IR, 但此表之hits(手寫, 依SQL三值邏輯手推)是SQL族對公開select與delAll之共同期望, 作為日後任何翻譯層變更之守門
+//規則: 依表之columns建model(models/tlower.js), seed()6列; 逐案對公開select與delAll驗——
+//  非schema案兩函數須皆接受, select命中 = delAll實際刪除之id集合 = hits; hits為[]者恆假;
+//  hits為null(字串順序比較依collation而異)只驗兩函數一致; schema為true者(型別化後端可因欄位型別拒收)可reject, 但兩函數須一致reject、資料不變, 未reject時須 = hits
+
+
+let { seed, semantics } = lowerCases
+
+let ALL = [1, 2, 3, 4, 5, 6]
+
+//案例表規模下限(wsemi 1.9.25為85案)與schema案之上限, 防止案例表被掏空後仍全綠
+let nMin = 85
+
+let ids = (rs) => rs.map((v) => v.id).sort((a, b) => a - b)
+
+let msgOf = (err) => String(err && err.message !== undefined ? err.message : err)
+
+//settle, 執行promise並回傳{ok,v}或{err}
+let settle = (pm) => pm.then((v) => ({ ok: true, v })).catch((err) => ({ err }))
+
+
+/**
+ * 定義共用測試套組
+ *
+ * @param {String} label 輸入後端名稱字串('sqlite'或'mssql'), 供describe標題使用
+ * @param {Function} getOpt 輸入取得建構設定之函數, 於hook內呼叫以取得當下有效之連線資訊
+ */
+export function defineLowerCaseSuites(label, getOpt) {
+
+    describe(`${label} lowerFind契約表: 案例逐案對select與delAll`, function() {
+
+        let w = null
+        let ins = null
+        let cs = null
+
+        //stats, 各案測試時累計, 供最末之防空轉斷言
+        let stats = { accepted: 0, acceptedHit: 0, acceptedNull: 0, rejected: 0 }
+
+        let reset = async () => {
+            await w.delAll({}, cs)
+            let r = await w.insert(seed(), cs)
+            assert.strictEqual(r.nInserted, 6)
+        }
+
+        before(async function() {
+            w = wo(getOpt({ cl: 'tlower' }))
+            await w.createStorage()
+            ins = await w.init()
+            cs = { instance: ins }
+        })
+
+        after(async function() {
+            await ins.close()
+        })
+
+        it(`案例表規模: 至少${nMin}案, 代號不重複, 含hits為[]、非空、null三類與schema案`, function() {
+            assert.ok(semantics.length >= nMin, `案數 ${semantics.length}`)
+            assert.strictEqual(new Set(semantics.map((c) => c.id)).size, semantics.length)
+            assert.ok(semantics.some((c) => Array.isArray(c.hits) && c.hits.length === 0))
+            assert.ok(semantics.some((c) => Array.isArray(c.hits) && c.hits.length > 0))
+            assert.ok(semantics.some((c) => c.hits === null))
+            assert.ok(semantics.some((c) => c.schema === true))
+        })
+
+        it('種子: 6列, id 1~6', async function() {
+            let sd = seed()
+            assert.deepStrictEqual(sd.map((v) => v.id), ALL)
+            await reset()
+            assert.deepStrictEqual(ids(await w.select({}, cs)), ALL)
+        })
+
+        for (let c of semantics) {
+
+            it(`${c.id} (${c.node}): select命中 = delAll刪除 = hits${c.hits === null ? '(null: 只驗兩函數一致)' : ''}${c.schema ? '(schema案可reject)' : ''}`, async function() {
+                await reset()
+                let rs = await settle(w.select(c.find(), cs))
+                if (rs.err !== undefined) {
+                    //schema案: 型別化後端可因欄位型別檢核而reject, 此時兩函數須一致reject且資料不變
+                    assert.ok(c.schema === true, `非schema案不得reject: ${msgOf(rs.err)}`)
+                    assert.strictEqual(msgOf(rs.err).indexOf('invalid find: '), 0, msgOf(rs.err))
+                    let before = ids(await w.select({}, cs))
+                    let rd = await settle(w.delAll(c.find(), cs))
+                    assert.ok(rd.err !== undefined, 'select reject而delAll未reject')
+                    assert.strictEqual(msgOf(rd.err), msgOf(rs.err))
+                    assert.deepStrictEqual(ids(await w.select({}, cs)), before)
+                    stats.rejected += 1
+                    return
+                }
+                let sel = ids(rs.v)
+                if (c.hits !== null) {
+                    assert.deepStrictEqual(sel, c.hits, 'select之命中')
+                }
+                let r = await w.delAll(c.find(), cs)
+                let left = ids(await w.select({}, cs))
+                let gone = ALL.filter((v) => left.indexOf(v) < 0)
+                assert.deepStrictEqual(gone, sel, 'delAll之刪除 = select之命中')
+                if (c.hits !== null) {
+                    assert.deepStrictEqual(gone, c.hits, 'delAll之刪除')
+                }
+                assert.deepStrictEqual(r, { n: gone.length, nDeleted: gone.length, ok: 1 })
+                stats.accepted += 1
+                if (c.hits === null) {
+                    stats.acceptedNull += 1
+                }
+                else if (c.hits.length > 0) {
+                    stats.acceptedHit += 1
+                }
+            })
+
+        }
+
+        it('防空轉: 全部非schema案皆被接受(任一正常案全部reject即紅), 且命中非空之案數達標', function() {
+            let nSchema = semantics.filter((c) => c.schema === true).length
+            let nHit = semantics.filter((c) => Array.isArray(c.hits) && c.hits.length > 0).length
+            assert.ok(stats.rejected <= nSchema, `reject ${stats.rejected} 案, 超過schema案數 ${nSchema}`)
+            assert.ok(stats.accepted >= semantics.length - nSchema, `接受 ${stats.accepted} 案, 少於 ${semantics.length - nSchema}`)
+            assert.ok(stats.acceptedHit >= nHit - nSchema, `命中非空之接受案 ${stats.acceptedHit} 少於 ${nHit - nSchema}`)
+            assert.ok(stats.acceptedHit >= 50, `命中非空之接受案 ${stats.acceptedHit} 不足50`)
+        })
+
+    })
+
+}

package/test/api-mssql.test.mjs

@@ -4,6 +4,10 @@ import { promisify } from 'util'
 import { defineSuites } from './api-suite.mjs'
 import { defineWhitelistSuites } from './api-find-whitelist.mjs'
 import { defineDateWriteSuites } from './api-date-write.mjs'
+import { defineWellformedSuites } from './api-wellformed.mjs'
+import { defineLowerCaseSuites } from './api-lower-cases.mjs'
+import { defineScopeSuites } from './api-scope.mjs'
+import { defineFloatSuites } from './api-float.mjs'
 
 
 //測試自行創建docker容器供MSSQL服務, 測試結束即銷毀, 故僅需環境已安裝docker
@@ -56,12 +60,23 @@ let startContainer = async () => {
             throw new Error('需先安裝並啟動docker才能執行mssql測試')
         })
 
-    //清除前次殘留容器
-    await docker(['rm', '-f', ctName]).catch(() => {})
+    //清除前次殘留容器(-v連其匿名volume一併移除)
+    await docker(['rm', '-f', '-v', ctName]).catch(() => {})
 
-    //run
-    ctPort = await getFreePort()
-    await docker(['run', '-d', '--rm', '--name', ctName, '-e', 'ACCEPT_EULA=Y', '-e', `MSSQL_SA_PASSWORD=${saPassword}`, '-p', `${ctPort}:1433`, ctImage])
+    //run, getFreePort取得埠到docker綁定之間可能被同機其他程序佔用(綁定失敗), 故換埠重試
+    for (let i = 0; ; i++) {
+        ctPort = await getFreePort()
+        try {
+            await docker(['run', '-d', '--rm', '--name', ctName, '-e', 'ACCEPT_EULA=Y', '-e', `MSSQL_SA_PASSWORD=${saPassword}`, '-p', `${ctPort}:1433`, ctImage])
+            break
+        }
+        catch (err) {
+            if (i >= 4 || String(err.message).indexOf('bind') < 0) {
+                throw err
+            }
+            await docker(['rm', '-f', '-v', ctName]).catch(() => {})
+        }
+    }
 
     //等待服務就緒, 首次需拉取映像故給予較長時間
     let ready = false
@@ -86,9 +101,30 @@ let startContainer = async () => {
 
 }
 
-//stopContainer, 銷毀容器
+//stopContainer, 銷毀容器: 強制移除須帶-v, 否則映像宣告之VOLUME會成為懸置之匿名volume(逐次累積而佔滿磁碟); 移除後回驗容器與其volume皆已不存在
 let stopContainer = async () => {
-    await docker(['rm', '-f', ctName]).catch(() => {})
+
+    //vols, 先記下容器掛載之volume名稱(移除後即無從查詢)
+    let vols = await docker(['inspect', '-f', '{{range .Mounts}}{{if eq .Type "volume"}}{{.Name}} {{end}}{{end}}', ctName])
+        .then((r) => String(r.stdout).trim().split(/\s+/).filter((v) => v !== ''))
+        .catch(() => [])
+
+    await docker(['rm', '-f', '-v', ctName]).catch(() => {})
+
+    //回驗: 容器已不存在
+    let left = await docker(['ps', '-a', '-q', '--filter', `name=^${ctName}$`]).then((r) => String(r.stdout).trim())
+    if (left !== '') {
+        throw new Error(`mssql容器[${ctName}]移除後仍存在`)
+    }
+
+    //回驗: 其volume已隨容器移除
+    for (let v of vols) {
+        let still = await docker(['volume', 'inspect', v]).then(() => true, () => false)
+        if (still) {
+            throw new Error(`mssql容器[${ctName}]之volume[${v}]未隨容器移除`)
+        }
+    }
+
 }
 
 
@@ -117,3 +153,7 @@ after(async function() {
 defineSuites('mssql', getOpt)
 defineWhitelistSuites('mssql', getOpt)
 defineDateWriteSuites('mssql', getOpt)
+defineWellformedSuites('mssql', getOpt)
+defineLowerCaseSuites('mssql', getOpt)
+defineScopeSuites('mssql', getOpt)
+defineFloatSuites('mssql', getOpt)

package/test/api-scope.mjs

@@ -0,0 +1,208 @@
+import fs from 'fs'
+import path from 'path'
+import assert from 'assert'
+import wo from '../src/WOrmReladb.mjs'
+
+
+//本檔為mssql與sqlite共用之defaultScope測試套組(CLAUDE_rulebook.md之R16), 由api-sqlite.test.mjs與api-mssql.test.mjs引入
+//sequelize預設以Object.assign合併scope.where與傳入where(同名頂層鍵後者覆寫), scope.where為Sequelize.literal或Sequelize.where(非一般物件)時scope直接被丟棄;
+//WOrmReladb於Sequelize實例之define層級設定whereMergeStrategy:'and', 令兩者一律以AND結合
+//5種defaultScope(純鍵、Op.or、Op.and、Sequelize.literal、Sequelize.where) x 5種find, 對公開select與delAll:
+//  select之命中 = delAll實際刪除之主鍵集合 = 手推期望(scope範圍內且符合find之列); delAll實際刪除之主鍵以不套scope之讀取(unscoped)取得, 不以select代替
+//Op.and之scope: chkScopeForDelAll維持拒收delAll(R1), select則須套用該scope
+
+
+let ROWS = [
+    { id: '1', g: 'A', name: 'x' },
+    { id: '2', g: 'B', name: 'x' },
+    { id: '3', g: 'A', name: 'y' },
+    { id: '4', g: 'C', name: 'x' },
+]
+
+//SCOPES, where為寫入model檔之defaultScope.where原始碼, inScope為scope範圍之手推判定
+let SCOPES = [
+    { key: 'pk', label: '純鍵', where: '{ g: \'A\' }', inScope: (r) => r.g === 'A', delAllRejects: false },
+    { key: 'or', label: 'Op.or', where: '{ [Op.or]: [{ g: \'A\' }, { g: \'C\' }] }', inScope: (r) => r.g === 'A' || r.g === 'C', delAllRejects: false },
+    { key: 'and', label: 'Op.and', where: '{ [Op.and]: [{ g: \'A\' }] }', inScope: (r) => r.g === 'A', delAllRejects: true },
+    { key: 'lit', label: 'Sequelize.literal', where: 'sequelize.literal(\'g = \\\'A\\\'\')', inScope: (r) => r.g === 'A', delAllRejects: false },
+    { key: 'whr', label: 'Sequelize.where', where: 'sequelize.where(sequelize.col(\'g\'), \'A\')', inScope: (r) => r.g === 'A', delAllRejects: false },
+    //model自身指定whereMergeStrategy:'overwrite'(蓋過Sequelize實例之define預設): 匯入後仍強制為'and'(外審sol F2)
+    { key: 'ovw', label: 'Sequelize.literal + model自身指定whereMergeStrategy overwrite', where: 'sequelize.literal(\'g = \\\'A\\\'\')', modelOpt: ', whereMergeStrategy: \'overwrite\'', inScope: (r) => r.g === 'A', delAllRejects: false },
+]
+
+//FINDS, p為find之手推判定
+let FINDS = [
+    { label: '{g:"B"}(與scope同欄之單葉)', find: () => ({ g: 'B' }), p: (r) => r.g === 'B' },
+    { label: '{name:"x"}(他欄單葉)', find: () => ({ name: 'x' }), p: (r) => r.name === 'x' },
+    { label: '$or根', find: () => ({ $or: [{ g: 'B' }, { name: 'y' }] }), p: (r) => r.g === 'B' || r.name === 'y' },
+    { label: 'and根(多欄)', find: () => ({ name: 'x', g: { $ne: 'Z' } }), p: (r) => r.name === 'x' && r.g !== 'Z' },
+    { label: '{}(全部)', find: () => ({}), p: () => true },
+]
+
+let ids = (rs) => rs.map((v) => v.id).sort()
+
+let msgOf = (err) => String(err && err.message !== undefined ? err.message : err)
+
+let genModel = (cl, where, modelOpt = '') => {
+    return [
+        'module.exports = function(sequelize, DataTypes) {',
+        '    let Op = require(\'sequelize\').Op',
+        `    return sequelize.define('${cl}', {`,
+        '        id: { type: DataTypes.STRING, allowNull: false, primaryKey: true },',
+        '        g: { type: DataTypes.STRING, allowNull: true },',
+        '        name: { type: DataTypes.STRING, allowNull: true },',
+        `    }, { tableName: '${cl}', defaultScope: { where: ${where} }${modelOpt} })`,
+        '}',
+        '',
+    ].join('\n')
+}
+
+
+/**
+ * 定義共用測試套組
+ *
+ * @param {String} label 輸入後端名稱字串('sqlite'或'mssql'), 供describe標題與暫存夾使用
+ * @param {Function} getOpt 輸入取得建構設定之函數, 於hook內呼叫以取得當下有效之連線資訊
+ */
+export function defineScopeSuites(label, getOpt) {
+
+    let fd = `./test/_tmp/api-scope-${label}`
+
+    describe(`${label} defaultScope: 6種scope(含model自身指定overwrite) x 5種find, select與delAll不越出scope`, function() {
+
+        before(function() {
+            fs.mkdirSync(fd, { recursive: true })
+            for (let sc of SCOPES) {
+                fs.writeFileSync(path.join(fd, `tsc${sc.key}.js`), genModel(`tsc${sc.key}`, sc.where, sc.modelOpt), 'utf8')
+            }
+        })
+
+        after(function() {
+            fs.rmSync(fd, { recursive: true, force: true })
+        })
+
+        for (let sc of SCOPES) {
+
+            describe(`scope ${sc.label}`, function() {
+
+                let cl = `tsc${sc.key}`
+                let w = null
+                let ins = null
+                let cs = null
+
+                //unscoped, 不套scope之全表讀取(取delAll實際刪除之主鍵), 不經select
+                let unscoped = async () => {
+                    return ids(await ins.mds[cl].unscoped().findAll({ raw: true }))
+                }
+
+                before(async function() {
+                    w = wo(getOpt({ cl, fdModels: fd }))
+                    await w.createStorage()
+                    ins = await w.init()
+                    cs = { instance: ins }
+                })
+
+                after(async function() {
+                    await ins.close()
+                })
+
+                beforeEach(async function() {
+                    await ins.mds[cl].unscoped().destroy({ where: {} })
+                    let r = await w.insert(ROWS, cs)
+                    assert.strictEqual(r.nInserted, 4)
+                    assert.deepStrictEqual(await unscoped(), ['1', '2', '3', '4'])
+                })
+
+                it('合併策略: Sequelize實例之define預設與匯入後之model皆為whereMergeStrategy:and(model自身指定overwrite者亦被改為and)', function() {
+                    let md = ins.mds[cl]
+                    assert.strictEqual(md.sequelize.options.define.whereMergeStrategy, 'and')
+                    assert.strictEqual(md.options.whereMergeStrategy, 'and')
+                })
+
+                it('前提: select({})僅回scope範圍內之列(scope確實套用)', async function() {
+                    let exp = ids(ROWS.filter(sc.inScope))
+                    assert.ok(exp.length > 0 && exp.length < ROWS.length, '夾具之scope須同時含範圍內外之列')
+                    assert.deepStrictEqual(ids(await w.select({}, cs)), exp)
+                })
+
+                for (let f of FINDS) {
+
+                    it(`${f.label}: select命中 = 手推期望(scope AND find)`, async function() {
+                        let exp = ids(ROWS.filter((r) => sc.inScope(r) && f.p(r)))
+                        assert.deepStrictEqual(ids(await w.select(f.find(), cs)), exp)
+                    })
+
+                    if (sc.delAllRejects) {
+                        it(`${f.label}: delAll拒收(chkScopeForDelAll維持, 含Op.and之scope.where)且不刪除`, async function() {
+                            let r = await w.delAll(f.find(), cs).then(() => null).catch((err) => msgOf(err))
+                            assert.ok(r !== null && r.indexOf('defaultScope') >= 0, `未reject: ${r}`)
+                            assert.deepStrictEqual(await unscoped(), ['1', '2', '3', '4'])
+                        })
+                    }
+                    else {
+                        it(`${f.label}: delAll實際刪除之主鍵集合 = 手推期望, 不越出scope`, async function() {
+                            let exp = ids(ROWS.filter((r) => sc.inScope(r) && f.p(r)))
+                            let r = await w.delAll(f.find(), cs)
+                            let left = await unscoped()
+                            let gone = ['1', '2', '3', '4'].filter((v) => left.indexOf(v) < 0)
+                            assert.deepStrictEqual(gone, exp, `delAll刪除之主鍵(scope範圍: ${ids(ROWS.filter(sc.inScope))})`)
+                            assert.ok(gone.every((v) => sc.inScope(ROWS.find((x) => x.id === v))), 'delAll刪到scope之外')
+                            assert.deepStrictEqual(r, { n: exp.length, nDeleted: exp.length, ok: 1 })
+                        })
+                    }
+
+                }
+
+                it('scope內之主鍵: selectByPk命中、del實際刪除該列(其餘列不動)、save更新該列完整欄位(外審sol F5)', async function() {
+                    let inRows = ROWS.filter(sc.inScope)
+                    let inId = inRows[0].id
+                    let other = ['1', '2', '3', '4'].filter((v) => v !== inId)
+                    assert.deepStrictEqual(await w.selectByPk(inId, cs), ROWS.find((r) => r.id === inId))
+                    //save: 更新scope內之列
+                    let rs = await w.save({ id: inId, g: inRows[0].g, name: 'zz' }, cs)
+                    assert.deepStrictEqual(rs, [{ n: 1, nInserted: 0, nModified: 1, ok: 1 }])
+                    assert.deepStrictEqual(await w.selectByPk(inId, cs), { id: inId, g: inRows[0].g, name: 'zz' })
+                    //del: 刪除scope內之列
+                    let rd = await w.del({ id: inId }, cs)
+                    assert.deepStrictEqual(rd, [{ n: 1, nDeleted: 1, ok: 1 }])
+                    assert.deepStrictEqual(await unscoped(), other, 'del只刪該列')
+                })
+
+                it('scope外已存在之主鍵: save(預設autoInsert:true)本筆失敗(ok:0, 預讀不見該列而改插入, 撞主鍵重試耗盡), 該列不改動(外審minimax F1; 修前literal/where scope下該列會被更新)', async function() {
+                    let outRow = ROWS.find((r) => !sc.inScope(r))
+                    let rs = await w.save({ id: outRow.id, g: outRow.g, name: 'zz' }, cs)
+                    assert.strictEqual(rs.length, 1)
+                    assert.strictEqual(rs[0].ok, 0, `scope外之既有主鍵save應失敗: ${JSON.stringify(rs)}`)
+                    assert.strictEqual(rs[0].nModified, 0)
+                    assert.strictEqual(rs[0].nInserted, 0)
+                    assert.ok(String(rs[0].err).indexOf('can not save') >= 0, String(rs[0].err))
+                    let row = (await ins.mds[cl].unscoped().findAll({ where: { id: outRow.id }, raw: true }))[0]
+                    assert.strictEqual(row.name, outRow.name, 'scope外之列被改動')
+                    assert.deepStrictEqual(await unscoped(), ['1', '2', '3', '4'])
+                })
+
+                it('scope外之主鍵: save(autoInsert:false)不改動該列(外審sol F5)', async function() {
+                    let outRow = ROWS.find((r) => !sc.inScope(r))
+                    let rs = await w.save({ id: outRow.id, g: outRow.g, name: 'zz' }, { ...cs, autoInsert: false })
+                    assert.strictEqual(rs[0].nModified, 0, `save更新了scope外之列: ${JSON.stringify(rs)}`)
+                    let row = (await ins.mds[cl].unscoped().findAll({ where: { id: outRow.id }, raw: true }))[0]
+                    assert.strictEqual(row.name, outRow.name, 'scope外之列被改動')
+                })
+
+                it('selectByPk、del亦不越出scope(scope外之主鍵: selectByPk回null、del不刪)', async function() {
+                    let outId = ROWS.find((r) => !sc.inScope(r)).id
+                    let inId = ROWS.find((r) => sc.inScope(r)).id
+                    assert.strictEqual(await w.selectByPk(outId, cs), null)
+                    assert.ok((await w.selectByPk(inId, cs)) !== null)
+                    let r = await w.del({ id: outId }, cs)
+                    assert.deepStrictEqual(r, [{ n: 0, nDeleted: 0, ok: 1 }], 'del刪到scope外之列')
+                    assert.deepStrictEqual(await unscoped(), ['1', '2', '3', '4'])
+                })
+
+            })
+
+        }
+
+    })
+
+}

package/test/api-sqlite.test.mjs

@@ -2,6 +2,10 @@ import fs from 'fs'
 import { defineSuites } from './api-suite.mjs'
 import { defineWhitelistSuites } from './api-find-whitelist.mjs'
 import { defineDateWriteSuites } from './api-date-write.mjs'
+import { defineWellformedSuites } from './api-wellformed.mjs'
+import { defineLowerCaseSuites } from './api-lower-cases.mjs'
+import { defineScopeSuites } from './api-scope.mjs'
+import { defineFloatSuites } from './api-float.mjs'
 
 
 //sqlite使用獨立暫存storage檔測試, 不使用專案根目錄之worm.sqlite
@@ -44,3 +48,7 @@ after(function() {
 defineSuites('sqlite', getOpt)
 defineWhitelistSuites('sqlite', getOpt)
 defineDateWriteSuites('sqlite', getOpt)
+defineWellformedSuites('sqlite', getOpt)
+defineLowerCaseSuites('sqlite', getOpt)
+defineScopeSuites('sqlite', getOpt)
+defineFloatSuites('sqlite', getOpt)