@coffeerunhobby/mcp-ha-connect 2.0.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -1
- package/dist/omadaClient/index.d.ts +7 -0
- package/dist/omadaClient/index.js +6 -0
- package/dist/omadaClient/index.js.map +1 -1
- package/dist/omadaClient/request.d.ts +4 -0
- package/dist/omadaClient/request.js +6 -0
- package/dist/omadaClient/request.js.map +1 -1
- package/dist/omadaClient/site.d.ts +129 -0
- package/dist/omadaClient/site.js +197 -0
- package/dist/omadaClient/site.js.map +1 -1
- package/dist/server/instructions.js +1 -1
- package/dist/server/instructions.js.map +1 -1
- package/dist/tools/omada/getSiteNtpStatus.d.ts +3 -0
- package/dist/tools/omada/getSiteNtpStatus.js +8 -0
- package/dist/tools/omada/getSiteNtpStatus.js.map +1 -0
- package/dist/tools/omada/index.js +7 -2
- package/dist/tools/omada/index.js.map +1 -1
- package/dist/tools/omada/namespace.js +8 -0
- package/dist/tools/omada/namespace.js.map +1 -1
- package/dist/tools/omada/setSiteNtpServers.d.ts +10 -0
- package/dist/tools/omada/setSiteNtpServers.js +22 -0
- package/dist/tools/omada/setSiteNtpServers.js.map +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/docs/CHANGELOG.md +9 -0
- package/openapi.json +1 -1
- package/package.json +1 -1
- package/src/omadaClient/index.ts +12 -1
- package/src/omadaClient/request.ts +7 -0
- package/src/omadaClient/site.ts +279 -1
- package/src/server/instructions.ts +1 -1
- package/src/tools/omada/getSiteNtpStatus.ts +14 -0
- package/src/tools/omada/index.ts +7 -2
- package/src/tools/omada/namespace.ts +8 -0
- package/src/tools/omada/setSiteNtpServers.ts +36 -0
- package/src/version.ts +1 -1
- package/tests/omadaClient/ntp.test.ts +381 -0
- package/tests/tools/omada/graph.test.ts +21 -2
package/src/tools/omada/index.ts
CHANGED
|
@@ -9,6 +9,7 @@ import { logger } from '../../utils/logger.js';
|
|
|
9
9
|
import { registerBlockClientTool } from './blockClient.js';
|
|
10
10
|
import { registerCyclePoePortTool } from './cyclePoePort.js';
|
|
11
11
|
import { registerOmadaGraphTools } from './graph.js';
|
|
12
|
+
import { registerSetSiteNtpServersTool } from './setSiteNtpServers.js';
|
|
12
13
|
import { registerSetSsidEnabledTool } from './setSsidEnabled.js';
|
|
13
14
|
import { registerDisableClientRateLimitTool } from './disableClientRateLimit.js';
|
|
14
15
|
import { registerGetClientTool } from './getClient.js';
|
|
@@ -19,6 +20,7 @@ import { registerGetLanNetworkListTool } from './getLanNetworkList.js';
|
|
|
19
20
|
import { registerGetLanProfileListTool } from './getLanProfileList.js';
|
|
20
21
|
import { registerGetPortForwardingStatusTool } from './getPortForwardingStatus.js';
|
|
21
22
|
import { registerGetRateLimitProfilesTool } from './getRateLimitProfiles.js';
|
|
23
|
+
import { registerGetSiteNtpStatusTool } from './getSiteNtpStatus.js';
|
|
22
24
|
import { registerGetSsidDetailTool } from './getSsidDetail.js';
|
|
23
25
|
import { registerGetSsidListTool } from './getSsidList.js';
|
|
24
26
|
import { registerGetSwitchStackDetailTool } from './getSwitchStackDetail.js';
|
|
@@ -59,7 +61,9 @@ export function registerOmadaTools(
|
|
|
59
61
|
|
|
60
62
|
// Site tools
|
|
61
63
|
registerListSitesTool(server, client);
|
|
62
|
-
|
|
64
|
+
registerGetSiteNtpStatusTool(server, client);
|
|
65
|
+
registerSetSiteNtpServersTool(server, client);
|
|
66
|
+
toolCount += 3;
|
|
63
67
|
|
|
64
68
|
// Device tools
|
|
65
69
|
registerListDevicesTool(server, client);
|
|
@@ -136,7 +140,8 @@ function registerOmadaToolsGraph(server: McpServer, client: OmadaClient): number
|
|
|
136
140
|
registerUnblockClientTool(server, client);
|
|
137
141
|
registerCyclePoePortTool(server, client);
|
|
138
142
|
registerSetSsidEnabledTool(server, client);
|
|
139
|
-
|
|
143
|
+
registerSetSiteNtpServersTool(server, client);
|
|
144
|
+
toolCount += 8;
|
|
140
145
|
|
|
141
146
|
logger.info('Omada tools registered', { mode: 'graph', toolCount });
|
|
142
147
|
return toolCount;
|
|
@@ -360,6 +360,14 @@ export const OMADA_RESOURCES: ResourceNode[] = [
|
|
|
360
360
|
description: 'Internet/WAN connection information for the site.',
|
|
361
361
|
fetch: (c, a) => c.getInternetInfo(a.siteId),
|
|
362
362
|
},
|
|
363
|
+
{
|
|
364
|
+
path: '/network/ntp',
|
|
365
|
+
kind: 'leaf',
|
|
366
|
+
permission: Q,
|
|
367
|
+
estimatedSize: 'small',
|
|
368
|
+
description: 'NTP (network time) server configuration and status for the site.',
|
|
369
|
+
fetch: (c, a) => c.getSiteNtpStatus(a.siteId),
|
|
370
|
+
},
|
|
363
371
|
{
|
|
364
372
|
path: '/network/lan-networks',
|
|
365
373
|
kind: 'collection',
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { McpServer } from '@modelcontextprotocol/server';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
|
|
4
|
+
import type { OmadaClient } from '../../omadaClient/index.js';
|
|
5
|
+
import { MAX_NTP_SERVERS } from '../../omadaClient/site.js';
|
|
6
|
+
import { toToolResult, wrapToolHandler, Permission } from '../common.js';
|
|
7
|
+
|
|
8
|
+
export const setSiteNtpServersSchema = z.object({
|
|
9
|
+
servers: z
|
|
10
|
+
.array(z.string().min(1))
|
|
11
|
+
.max(MAX_NTP_SERVERS)
|
|
12
|
+
.describe(`NTP server addresses (hostname or IPv4), in priority order; at most ${MAX_NTP_SERVERS}. Replaces the current list.`),
|
|
13
|
+
enabled: z.boolean().optional().describe('Turn the site NTP setting on (default) or off'),
|
|
14
|
+
siteId: z.string().min(1).optional(),
|
|
15
|
+
dryRun: z.boolean().optional().describe('If true, return the exact change without writing it'),
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
export function registerSetSiteNtpServersTool(server: McpServer, client: OmadaClient): void {
|
|
19
|
+
server.registerTool(
|
|
20
|
+
'omada_setSiteNtpServers',
|
|
21
|
+
{
|
|
22
|
+
description:
|
|
23
|
+
"Set a site's NTP (network time) servers, replacing the current list. " +
|
|
24
|
+
'Omada stores NTP in the site settings, so this re-writes the site settings with only the NTP fields changed; ' +
|
|
25
|
+
'the result shows the list before and after. Use dryRun first to preview. ' +
|
|
26
|
+
'Wrong time breaks certificates, logs and schedules on every network device - confirm with the user before applying.',
|
|
27
|
+
inputSchema: setSiteNtpServersSchema,
|
|
28
|
+
},
|
|
29
|
+
wrapToolHandler(
|
|
30
|
+
'omada_setSiteNtpServers',
|
|
31
|
+
async ({ servers, enabled, siteId, dryRun }: z.infer<typeof setSiteNtpServersSchema>) =>
|
|
32
|
+
toToolResult(await client.setSiteNtpServers(servers, { enabled, siteId, dryRun })),
|
|
33
|
+
Permission.CONFIGURE
|
|
34
|
+
)
|
|
35
|
+
);
|
|
36
|
+
}
|
package/src/version.ts
CHANGED
|
@@ -0,0 +1,381 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Unit tests for the site NTP operations:
|
|
3
|
+
* - ntpAddressError / buildSiteUpdateBody (pure helpers)
|
|
4
|
+
* - SiteOperations.getSiteNtpStatus / setSiteNtpServers (read-modify-write of PUT /sites/{siteId})
|
|
5
|
+
* - the omada_getSiteNtpStatus / omada_setSiteNtpServers tools (RBAC + argument plumbing)
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
|
9
|
+
import type { McpServer } from '@modelcontextprotocol/server';
|
|
10
|
+
|
|
11
|
+
import type { OmadaClient } from '../../src/omadaClient/index.js';
|
|
12
|
+
import type { RequestHandler } from '../../src/omadaClient/request.js';
|
|
13
|
+
import { SiteOperations, buildSiteUpdateBody, ntpAddressError, type OmadaSiteInfo } from '../../src/omadaClient/site.js';
|
|
14
|
+
import { registerGetSiteNtpStatusTool } from '../../src/tools/omada/getSiteNtpStatus.js';
|
|
15
|
+
import { registerSetSiteNtpServersTool } from '../../src/tools/omada/setSiteNtpServers.js';
|
|
16
|
+
import { Permission } from '../../src/permissions/index.js';
|
|
17
|
+
|
|
18
|
+
const buildPath = (p: string): string => `/openapi/v1/omadac1${p.startsWith('/') ? p : `/${p}`}`;
|
|
19
|
+
|
|
20
|
+
function createMockRequest() {
|
|
21
|
+
return {
|
|
22
|
+
get: vi.fn(),
|
|
23
|
+
put: vi.fn(),
|
|
24
|
+
// Mirrors the real ensureSuccess: unwrap result, throw on errorCode !== 0
|
|
25
|
+
ensureSuccess: vi.fn((response: { errorCode: number; msg?: string; result?: unknown }) => {
|
|
26
|
+
if (response.errorCode !== 0) {
|
|
27
|
+
throw new Error(response.msg ?? `Omada error ${String(response.errorCode)}`);
|
|
28
|
+
}
|
|
29
|
+
return response.result;
|
|
30
|
+
}),
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const ok = (result?: unknown) => ({ errorCode: 0, msg: 'Success', result });
|
|
35
|
+
|
|
36
|
+
/** A site as GET /sites/{siteId} returns it, including read-only DST fields. */
|
|
37
|
+
function siteFixture(overrides: Partial<OmadaSiteInfo> = {}): OmadaSiteInfo {
|
|
38
|
+
return {
|
|
39
|
+
siteId: 'site-1',
|
|
40
|
+
name: 'Tower',
|
|
41
|
+
type: 0,
|
|
42
|
+
tagIds: ['tag-a'],
|
|
43
|
+
region: 'RO',
|
|
44
|
+
timeZone: 'Europe/Bucharest',
|
|
45
|
+
scenario: 'Home',
|
|
46
|
+
ntpEnable: false,
|
|
47
|
+
ntpServers: ['old.example.org'],
|
|
48
|
+
dst: {
|
|
49
|
+
enable: true,
|
|
50
|
+
mode: 1,
|
|
51
|
+
start: { month: 3, serial: 5, day: 7, hour: 3, minute: 0 },
|
|
52
|
+
end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 },
|
|
53
|
+
offset: 3600000,
|
|
54
|
+
status: true,
|
|
55
|
+
startTime: 1774746000000,
|
|
56
|
+
endTime: 1792890000000,
|
|
57
|
+
nextStart: 1806195600000,
|
|
58
|
+
},
|
|
59
|
+
longitude: 25.6,
|
|
60
|
+
latitude: 45.65,
|
|
61
|
+
address: 'Brasov',
|
|
62
|
+
supportES: true,
|
|
63
|
+
supportL2: true,
|
|
64
|
+
...overrides,
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const APPROVED = ['82.76.255.14', '194.102.58.251'];
|
|
69
|
+
|
|
70
|
+
describe('ntpAddressError', () => {
|
|
71
|
+
it.each(['82.76.255.14', '194.102.58.251', 'time.nipne.ro', 'ro.pool.ntp.org', '0.0.0.0'])(
|
|
72
|
+
'accepts %s',
|
|
73
|
+
(address) => {
|
|
74
|
+
expect(ntpAddressError(address)).toBeNull();
|
|
75
|
+
}
|
|
76
|
+
);
|
|
77
|
+
|
|
78
|
+
it.each([
|
|
79
|
+
'999.1.1.1',
|
|
80
|
+
'1.2.3',
|
|
81
|
+
'1.2.3.4.5',
|
|
82
|
+
'01.2.3.4',
|
|
83
|
+
'localhost',
|
|
84
|
+
'http://time.nipne.ro',
|
|
85
|
+
'time nipne.ro',
|
|
86
|
+
'-bad.example.org',
|
|
87
|
+
'x',
|
|
88
|
+
'',
|
|
89
|
+
])('rejects %s', (address) => {
|
|
90
|
+
expect(ntpAddressError(address)).toMatch(/not a valid/);
|
|
91
|
+
});
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
describe('buildSiteUpdateBody', () => {
|
|
95
|
+
it('carries over every writable site field and changes only NTP', () => {
|
|
96
|
+
const body = buildSiteUpdateBody(siteFixture(), APPROVED, true);
|
|
97
|
+
|
|
98
|
+
expect(body).toEqual({
|
|
99
|
+
name: 'Tower',
|
|
100
|
+
region: 'RO',
|
|
101
|
+
timeZone: 'Europe/Bucharest',
|
|
102
|
+
scenario: 'Home',
|
|
103
|
+
tagIds: ['tag-a'],
|
|
104
|
+
ntpEnable: true,
|
|
105
|
+
ntpServers: [{ address: '82.76.255.14' }, { address: '194.102.58.251' }],
|
|
106
|
+
dst: {
|
|
107
|
+
enable: true,
|
|
108
|
+
mode: 1,
|
|
109
|
+
start: { month: 3, serial: 5, day: 7, hour: 3, minute: 0 },
|
|
110
|
+
end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 },
|
|
111
|
+
offset: 3600000,
|
|
112
|
+
},
|
|
113
|
+
longitude: 25.6,
|
|
114
|
+
latitude: 45.65,
|
|
115
|
+
address: 'Brasov',
|
|
116
|
+
supportES: true,
|
|
117
|
+
supportL2: true,
|
|
118
|
+
});
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
it('drops read-only fields (siteId, type, DST status/timestamps)', () => {
|
|
122
|
+
const body = buildSiteUpdateBody(siteFixture(), APPROVED, true) as unknown as Record<string, unknown>;
|
|
123
|
+
|
|
124
|
+
expect(body).not.toHaveProperty('siteId');
|
|
125
|
+
expect(body).not.toHaveProperty('type');
|
|
126
|
+
expect(Object.keys(body.dst as object).sort()).toEqual(['enable', 'end', 'mode', 'offset', 'start']);
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it('drops the empty DST start/end the controller returns when DST is off (it rejects them on write)', () => {
|
|
130
|
+
// Shape seen live on Omada: DST off, start/end as empty objects.
|
|
131
|
+
const site = siteFixture({ dst: { enable: false, mode: 0, start: {} as never, end: {} as never } });
|
|
132
|
+
|
|
133
|
+
expect(buildSiteUpdateBody(site, APPROVED, true).dst).toEqual({ enable: false, mode: 0 });
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
it('refuses to write when DST is on but its start/end is incomplete', () => {
|
|
137
|
+
const site = siteFixture({
|
|
138
|
+
dst: { enable: true, mode: 2, start: { month: 3 } as never, end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 } },
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
expect(() => buildSiteUpdateBody(site, APPROVED, true)).toThrow(/daylight saving enabled but an incomplete start\/end/);
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
it('omits optional fields the site does not have instead of sending undefined', () => {
|
|
145
|
+
const site: OmadaSiteInfo = { region: 'RO', timeZone: 'Europe/Bucharest', scenario: 'Home' };
|
|
146
|
+
const body = buildSiteUpdateBody(site, APPROVED, true);
|
|
147
|
+
|
|
148
|
+
expect(Object.keys(body).sort()).toEqual(['ntpEnable', 'ntpServers', 'region', 'scenario', 'timeZone']);
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
it.each(['region', 'timeZone', 'scenario'] as const)('refuses to build a body when %s is missing', (field) => {
|
|
152
|
+
const site = siteFixture({ [field]: undefined } as Partial<OmadaSiteInfo>);
|
|
153
|
+
|
|
154
|
+
expect(() => buildSiteUpdateBody(site, APPROVED, true)).toThrow(new RegExp(`missing '${field}'.*refusing to write`));
|
|
155
|
+
});
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
describe('SiteOperations NTP', () => {
|
|
159
|
+
let request: ReturnType<typeof createMockRequest>;
|
|
160
|
+
let ops: SiteOperations;
|
|
161
|
+
|
|
162
|
+
beforeEach(() => {
|
|
163
|
+
request = createMockRequest();
|
|
164
|
+
ops = new SiteOperations(request as unknown as RequestHandler, buildPath, 'site-1');
|
|
165
|
+
});
|
|
166
|
+
|
|
167
|
+
it('getSiteNtpStatus GETs the site ntp setting', async () => {
|
|
168
|
+
request.get.mockResolvedValue(ok({ ntpEnable: true }));
|
|
169
|
+
|
|
170
|
+
await expect(ops.getSiteNtpStatus()).resolves.toEqual({ ntpEnable: true });
|
|
171
|
+
expect(request.get).toHaveBeenCalledWith('/openapi/v1/omadac1/sites/site-1/setting/ntp');
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
it('dryRun returns the exact PUT body and does not write', async () => {
|
|
175
|
+
request.get.mockResolvedValue(ok(siteFixture()));
|
|
176
|
+
|
|
177
|
+
const result = await ops.setSiteNtpServers(APPROVED, { dryRun: true });
|
|
178
|
+
|
|
179
|
+
expect(request.put).not.toHaveBeenCalled();
|
|
180
|
+
expect(result.applied).toBe(false);
|
|
181
|
+
expect(result.before).toEqual({ ntpEnable: false, ntpServers: ['old.example.org'] });
|
|
182
|
+
expect(result.after).toEqual({ ntpEnable: true, ntpServers: APPROVED });
|
|
183
|
+
expect(result.request).toEqual(buildSiteUpdateBody(siteFixture(), APPROVED, true));
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
it('PUTs the full site body, then reports what the controller holds afterwards', async () => {
|
|
187
|
+
request.get
|
|
188
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
189
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
190
|
+
.mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: APPROVED })));
|
|
191
|
+
request.put.mockResolvedValue(ok());
|
|
192
|
+
|
|
193
|
+
const result = await ops.setSiteNtpServers(APPROVED);
|
|
194
|
+
|
|
195
|
+
expect(request.get).toHaveBeenNthCalledWith(1, '/openapi/v1/omadac1/sites/site-1');
|
|
196
|
+
expect(request.put).toHaveBeenCalledWith(
|
|
197
|
+
'/openapi/v1/omadac1/sites/site-1',
|
|
198
|
+
buildSiteUpdateBody(siteFixture(), APPROVED, true)
|
|
199
|
+
);
|
|
200
|
+
expect(request.get).toHaveBeenCalledTimes(3);
|
|
201
|
+
expect(result).toMatchObject({
|
|
202
|
+
siteId: 'site-1',
|
|
203
|
+
siteName: 'Tower',
|
|
204
|
+
applied: true,
|
|
205
|
+
before: { ntpEnable: false, ntpServers: ['old.example.org'] },
|
|
206
|
+
after: { ntpEnable: true, ntpServers: APPROVED },
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
it('reports the controller state, even when it differs from the request', async () => {
|
|
211
|
+
request.get
|
|
212
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
213
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
214
|
+
.mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: ['82.76.255.14'] })));
|
|
215
|
+
request.put.mockResolvedValue(ok());
|
|
216
|
+
|
|
217
|
+
const result = await ops.setSiteNtpServers(APPROVED);
|
|
218
|
+
|
|
219
|
+
expect(result.after.ntpServers).toEqual(['82.76.255.14']);
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
it('uses an explicit siteId and encodes it', async () => {
|
|
223
|
+
request.get.mockResolvedValue(ok(siteFixture()));
|
|
224
|
+
|
|
225
|
+
await ops.setSiteNtpServers(APPROVED, { siteId: 'a/b', dryRun: true });
|
|
226
|
+
|
|
227
|
+
expect(request.get).toHaveBeenCalledWith('/openapi/v1/omadac1/sites/a%2Fb');
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
it('allows turning NTP off with an empty list', async () => {
|
|
231
|
+
request.get.mockResolvedValue(ok(siteFixture({ ntpEnable: true })));
|
|
232
|
+
|
|
233
|
+
const result = await ops.setSiteNtpServers([], { enabled: false, dryRun: true });
|
|
234
|
+
|
|
235
|
+
expect(result.request.ntpEnable).toBe(false);
|
|
236
|
+
expect(result.request.ntpServers).toEqual([]);
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
it.each([
|
|
240
|
+
{ servers: [] as string[], enabled: true, error: /At least one NTP server/ },
|
|
241
|
+
{ servers: ['1.1.1.1', '2.2.2.2', '3.3.3.3', '4.4.4.4', '5.5.5.5', '6.6.6.6'], enabled: true, error: /at most 5/ },
|
|
242
|
+
{ servers: ['82.76.255.14', '999.1.1.1'], enabled: true, error: /'999.1.1.1' is not a valid IPv4/ },
|
|
243
|
+
{ servers: ['82.76.255.14', '82.76.255.14'], enabled: true, error: /duplicates/ },
|
|
244
|
+
])('rejects $servers before contacting the controller', async ({ servers, enabled, error }) => {
|
|
245
|
+
await expect(ops.setSiteNtpServers(servers, { enabled })).rejects.toThrow(error);
|
|
246
|
+
expect(request.get).not.toHaveBeenCalled();
|
|
247
|
+
expect(request.put).not.toHaveBeenCalled();
|
|
248
|
+
});
|
|
249
|
+
|
|
250
|
+
it('propagates a controller rejection of the PUT and does not report success', async () => {
|
|
251
|
+
request.get.mockResolvedValue(ok(siteFixture()));
|
|
252
|
+
request.put.mockResolvedValue({ errorCode: -1, msg: 'Permission denied' });
|
|
253
|
+
|
|
254
|
+
await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow('Permission denied');
|
|
255
|
+
expect(request.get).toHaveBeenCalledTimes(2);
|
|
256
|
+
});
|
|
257
|
+
|
|
258
|
+
it('refuses to write when a non-NTP setting changed between the read and the write', async () => {
|
|
259
|
+
request.get
|
|
260
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
261
|
+
.mockResolvedValueOnce(ok(siteFixture({ timeZone: 'Europe/London' })));
|
|
262
|
+
|
|
263
|
+
await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow(/changed while preparing.*nothing was written/);
|
|
264
|
+
expect(request.put).not.toHaveBeenCalled();
|
|
265
|
+
});
|
|
266
|
+
|
|
267
|
+
it('ignores NTP-only differences between the two reads (NTP is what is being set)', async () => {
|
|
268
|
+
request.get
|
|
269
|
+
.mockResolvedValueOnce(ok(siteFixture()))
|
|
270
|
+
.mockResolvedValueOnce(ok(siteFixture({ ntpServers: ['someone.else.org'] })))
|
|
271
|
+
.mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: APPROVED })));
|
|
272
|
+
request.put.mockResolvedValue(ok());
|
|
273
|
+
|
|
274
|
+
await expect(ops.setSiteNtpServers(APPROVED)).resolves.toMatchObject({ applied: true });
|
|
275
|
+
});
|
|
276
|
+
|
|
277
|
+
it('serializes concurrent writes to the same site: the second reads only after the first wrote', async () => {
|
|
278
|
+
const events: string[] = [];
|
|
279
|
+
let state = siteFixture();
|
|
280
|
+
request.get.mockImplementation(async () => {
|
|
281
|
+
events.push('get');
|
|
282
|
+
await new Promise((r) => setTimeout(r, 5));
|
|
283
|
+
return ok(state);
|
|
284
|
+
});
|
|
285
|
+
request.put.mockImplementation(async (_path: string, body: { ntpServers: Array<{ address: string }> }) => {
|
|
286
|
+
events.push('put');
|
|
287
|
+
await new Promise((r) => setTimeout(r, 5));
|
|
288
|
+
state = { ...state, ntpEnable: true, ntpServers: body.ntpServers.map((s) => s.address) };
|
|
289
|
+
return ok();
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
const [first, second] = await Promise.all([
|
|
293
|
+
ops.setSiteNtpServers(['82.76.255.14']),
|
|
294
|
+
ops.setSiteNtpServers(['194.102.58.251']),
|
|
295
|
+
]);
|
|
296
|
+
|
|
297
|
+
expect(events).toEqual(['get', 'get', 'put', 'get', 'get', 'get', 'put', 'get']);
|
|
298
|
+
expect(first.after.ntpServers).toEqual(['82.76.255.14']);
|
|
299
|
+
expect(second.before.ntpServers).toEqual(['82.76.255.14']);
|
|
300
|
+
expect(second.after.ntpServers).toEqual(['194.102.58.251']);
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
it('a failed write does not block the next one', async () => {
|
|
304
|
+
request.get.mockResolvedValue(ok(siteFixture()));
|
|
305
|
+
request.put.mockResolvedValueOnce({ errorCode: -1, msg: 'boom' }).mockResolvedValueOnce(ok());
|
|
306
|
+
|
|
307
|
+
await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow('boom');
|
|
308
|
+
await expect(ops.setSiteNtpServers(APPROVED)).resolves.toMatchObject({ applied: true });
|
|
309
|
+
});
|
|
310
|
+
|
|
311
|
+
it('does not write when the site info lacks a required field', async () => {
|
|
312
|
+
request.get.mockResolvedValue(ok(siteFixture({ scenario: '' })));
|
|
313
|
+
|
|
314
|
+
await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow(/missing 'scenario'/);
|
|
315
|
+
expect(request.put).not.toHaveBeenCalled();
|
|
316
|
+
});
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
// ---- Tools -------------------------------------------------------------------
|
|
320
|
+
|
|
321
|
+
type Handler = (args: unknown, extra: unknown) => Promise<{ content: { text: string }[] }>;
|
|
322
|
+
|
|
323
|
+
function createMockServer() {
|
|
324
|
+
const handlers = new Map<string, Handler>();
|
|
325
|
+
return {
|
|
326
|
+
registerTool: vi.fn((name: string, _config: unknown, handler: Handler) => {
|
|
327
|
+
handlers.set(name, handler);
|
|
328
|
+
}),
|
|
329
|
+
handlers,
|
|
330
|
+
} as unknown as McpServer & { handlers: Map<string, Handler> };
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
const extraWith = (permissions: number) => ({
|
|
334
|
+
sessionId: 'test-session',
|
|
335
|
+
http: { authInfo: { extra: { permissions } } },
|
|
336
|
+
});
|
|
337
|
+
|
|
338
|
+
const parse = (result: { content: { text: string }[] }) => JSON.parse(result.content[0].text) as Record<string, unknown>;
|
|
339
|
+
|
|
340
|
+
describe('omada NTP tools', () => {
|
|
341
|
+
let server: ReturnType<typeof createMockServer>;
|
|
342
|
+
let client: { getSiteNtpStatus: ReturnType<typeof vi.fn>; setSiteNtpServers: ReturnType<typeof vi.fn> };
|
|
343
|
+
|
|
344
|
+
beforeEach(() => {
|
|
345
|
+
server = createMockServer();
|
|
346
|
+
client = { getSiteNtpStatus: vi.fn(), setSiteNtpServers: vi.fn() };
|
|
347
|
+
registerGetSiteNtpStatusTool(server, client as unknown as OmadaClient);
|
|
348
|
+
registerSetSiteNtpServersTool(server, client as unknown as OmadaClient);
|
|
349
|
+
});
|
|
350
|
+
|
|
351
|
+
it('omada_getSiteNtpStatus needs only QUERY', async () => {
|
|
352
|
+
client.getSiteNtpStatus.mockResolvedValue({ ntpEnable: true });
|
|
353
|
+
|
|
354
|
+
const result = await server.handlers.get('omada_getSiteNtpStatus')!({ siteId: 's1' }, extraWith(Permission.QUERY));
|
|
355
|
+
|
|
356
|
+
expect(parse(result)).toEqual({ ntpEnable: true });
|
|
357
|
+
expect(client.getSiteNtpStatus).toHaveBeenCalledWith('s1');
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
it('omada_setSiteNtpServers is denied to a CONTROL + QUERY caller (needs CONFIGURE)', async () => {
|
|
361
|
+
const result = await server.handlers.get('omada_setSiteNtpServers')!(
|
|
362
|
+
{ servers: APPROVED },
|
|
363
|
+
extraWith(Permission.QUERY | Permission.CONTROL)
|
|
364
|
+
);
|
|
365
|
+
|
|
366
|
+
expect(parse(result)).toMatchObject({ error: 'Permission denied' });
|
|
367
|
+
expect(parse(result).message).toContain('CONFIGURE');
|
|
368
|
+
expect(client.setSiteNtpServers).not.toHaveBeenCalled();
|
|
369
|
+
});
|
|
370
|
+
|
|
371
|
+
it('omada_setSiteNtpServers passes servers and options through for a CONFIGURE caller', async () => {
|
|
372
|
+
client.setSiteNtpServers.mockResolvedValue({ applied: false });
|
|
373
|
+
|
|
374
|
+
await server.handlers.get('omada_setSiteNtpServers')!(
|
|
375
|
+
{ servers: APPROVED, siteId: 's1', dryRun: true },
|
|
376
|
+
extraWith(Permission.CONFIGURE)
|
|
377
|
+
);
|
|
378
|
+
|
|
379
|
+
expect(client.setSiteNtpServers).toHaveBeenCalledWith(APPROVED, { enabled: undefined, siteId: 's1', dryRun: true });
|
|
380
|
+
});
|
|
381
|
+
});
|
|
@@ -31,6 +31,7 @@ function createMockClient() {
|
|
|
31
31
|
getClient: vi.fn(),
|
|
32
32
|
listMostActiveClients: vi.fn(),
|
|
33
33
|
getInternetInfo: vi.fn(),
|
|
34
|
+
getSiteNtpStatus: vi.fn(),
|
|
34
35
|
getLanNetworkList: vi.fn(),
|
|
35
36
|
getLanProfileList: vi.fn(),
|
|
36
37
|
getWlanGroupList: vi.fn(),
|
|
@@ -78,11 +79,11 @@ describe('Omada graph tools - registration', () => {
|
|
|
78
79
|
expect(server.handlers.has('omada_read')).toBe(true);
|
|
79
80
|
});
|
|
80
81
|
|
|
81
|
-
it('graph mode registers browse + read +
|
|
82
|
+
it('graph mode registers browse + read + 8 typed writes, and NO typed getters', () => {
|
|
82
83
|
const server = createMockServer();
|
|
83
84
|
const client = createMockClient();
|
|
84
85
|
const count = registerOmadaTools(server, client, 'graph');
|
|
85
|
-
expect(count).toBe(
|
|
86
|
+
expect(count).toBe(10);
|
|
86
87
|
const names = [...server.handlers.keys()];
|
|
87
88
|
expect(names).toContain('omada_browse');
|
|
88
89
|
expect(names).toContain('omada_read');
|
|
@@ -91,9 +92,11 @@ describe('Omada graph tools - registration', () => {
|
|
|
91
92
|
// v1.6 action tools ride along in graph mode too (writes stay typed).
|
|
92
93
|
expect(names).toContain('omada_cyclePoePort');
|
|
93
94
|
expect(names).toContain('omada_setSsidEnabled');
|
|
95
|
+
expect(names).toContain('omada_setSiteNtpServers');
|
|
94
96
|
// Typed read getters must NOT be present in graph mode.
|
|
95
97
|
expect(names).not.toContain('omada_listSites');
|
|
96
98
|
expect(names).not.toContain('omada_getFirewallSetting');
|
|
99
|
+
expect(names).not.toContain('omada_getSiteNtpStatus');
|
|
97
100
|
});
|
|
98
101
|
|
|
99
102
|
it('eager mode (default) registers the typed getters, not the graph tools', () => {
|
|
@@ -291,6 +294,22 @@ describe('omada_read', () => {
|
|
|
291
294
|
expect(data.missing).toEqual(['wlanId']);
|
|
292
295
|
});
|
|
293
296
|
|
|
297
|
+
it('reads /network/ntp via getSiteNtpStatus, forwarding an explicit siteId', async () => {
|
|
298
|
+
(client.getSiteNtpStatus as ReturnType<typeof vi.fn>).mockResolvedValue({ ntpEnable: true, ntpServers: ['82.76.255.14'] });
|
|
299
|
+
const { isError, data } = parseResult(await read({ path: '/network/ntp', siteId: 'site9' }, readonlyExtra));
|
|
300
|
+
expect(isError).toBeFalsy();
|
|
301
|
+
expect(data).toEqual({ ntpEnable: true, ntpServers: ['82.76.255.14'] });
|
|
302
|
+
expect(client.getSiteNtpStatus).toHaveBeenCalledWith('site9');
|
|
303
|
+
expect(client.getInternetInfo).not.toHaveBeenCalled();
|
|
304
|
+
});
|
|
305
|
+
|
|
306
|
+
it('denies /network/ntp without QUERY and never calls the controller', async () => {
|
|
307
|
+
const { isError, data } = parseResult(await read({ path: '/network/ntp' }, noPermsExtra));
|
|
308
|
+
expect(isError).toBe(true);
|
|
309
|
+
expect(data.error).toBe('Permission denied');
|
|
310
|
+
expect(client.getSiteNtpStatus).not.toHaveBeenCalled();
|
|
311
|
+
});
|
|
312
|
+
|
|
294
313
|
it('enforces per-path permission (fail closed) for under-privileged callers', async () => {
|
|
295
314
|
const { isError, data } = parseResult(await read({ path: '/sites' }, noPermsExtra));
|
|
296
315
|
expect(isError).toBe(true);
|