Skip to content

Commit

Permalink
Test a bunch of JavaScript stuff.
Browse files Browse the repository at this point in the history
These are supposed to be defined by IDL but various
environments, like node.js, require manual implementation
of many of these behaviors. So, test them so an implementation
knows it's doing the same as others.
  • Loading branch information
greggman committed Jan 17, 2025
1 parent 1a434ee commit 8ba8a9a
Showing 1 changed file with 339 additions and 0 deletions.
339 changes: 339 additions & 0 deletions src/webgpu/idl/javascript.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
export const description = `
Validate that various GPU objects behave correctly in JavaScript.
Examples:
- GPUTexture, GPUBuffer, GPUQuerySet, GPUDevice, GPUAdapter, GPUAdapter.limits, GPUDevice.limits
- return nothing for Object.keys()
- adds no properties for {...object}
- iterate over keys for (key in object)
- throws for (key of object)
- return nothing from Object.getOwnPropertyDescriptors
- GPUAdapter.limits, GPUDevice.limits
- can not be passed to requestAdapter as requiredLimits
- GPUAdapter.features, GPUDevice.features
- do spread to array
- can be copied to set
- can be passed to requestAdapter as requiredFeatures
`;

import { TestCaseRecorder, TestParams } from '../../common/framework/fixture.js';
import { makeTestGroup } from '../../common/framework/test_group.js';
import { keysOf } from '../../common/util/data_tables.js';
import { getGPU } from '../../common/util/navigator_gpu.js';
import { assert, objectEquals, unreachable } from '../../common/util/util.js';
import { getDefaultLimitsForAdapter, kLimits } from '../capability_info.js';
import {
DeviceSelectionDescriptor,
GPUTest,
GPUTestSubcaseBatchState,
initUncanonicalizedDeviceDescriptor,
} from '../gpu_test.js';
import { CanonicalDeviceDescriptor, DescriptorModifier } from '../util/device_pool.js';

function addAllFeatures(adapter: GPUAdapter, desc: CanonicalDeviceDescriptor | undefined) {
const descWithMaxLimits: CanonicalDeviceDescriptor = {
defaultQueue: {},
...desc,
requiredFeatures: [...adapter.features] as GPUFeatureName[],
requiredLimits: {},
};
return descWithMaxLimits;
}

/**
* Used to request a device with all the max limits of the adapter.
*/
class AllFeaturesGPUTestSubcaseBatchState extends GPUTestSubcaseBatchState {
override requestDeviceWithRequiredParametersOrSkip(
descriptor: DeviceSelectionDescriptor,
descriptorModifier?: DescriptorModifier
): void {
const mod: DescriptorModifier = {
descriptorModifier(adapter: GPUAdapter, desc: CanonicalDeviceDescriptor | undefined) {
desc = descriptorModifier?.descriptorModifier
? descriptorModifier.descriptorModifier(adapter, desc)
: desc;
return addAllFeatures(adapter, desc);
},
keyModifier(baseKey: string) {
return `${baseKey}:AllFeaturesTest`;
},
};
super.requestDeviceWithRequiredParametersOrSkip(
initUncanonicalizedDeviceDescriptor(descriptor),
mod
);
}
}

/**
* A Test that requests all the max limits from the adapter on the device.
*/
class AllFeaturesTest extends GPUTest {
public static override MakeSharedState(
recorder: TestCaseRecorder,
params: TestParams
): GPUTestSubcaseBatchState {
return new AllFeaturesGPUTestSubcaseBatchState(recorder, params);
}
}

const kResourceInfo = {
buffer: {
create(t: GPUTest) {
return t.createBufferTracked({ size: 16, usage: GPUBufferUsage.UNIFORM });
},
requiredKeys: [
'destroy',
'getMappedRange',
'label',
'mapAsync',
'mapState',
'size',
'unmap',
'usage',
],
},
texture: {
create(t: GPUTest) {
return t.createTextureTracked({
size: [2, 3],
format: 'r8unorm',
usage: GPUTextureUsage.TEXTURE_BINDING,
});
},
requiredKeys: [
'createView',
'depthOrArrayLayers',
'destroy',
'dimension',
'format',
'height',
'label',
'mipLevelCount',
'sampleCount',
'usage',
'width',
],
},
querySet: {
create(t: GPUTest) {
return t.createQuerySetTracked({
type: 'occlusion',
count: 2,
});
},
requiredKeys: ['count', 'destroy', 'label', 'type'],
},
adapter: {
create(t: GPUTest) {
return t.adapter;
},
requiredKeys: [
'featureLevel',
'features',
'info',
'isCompatibilityMode',
'isFallbackAdapter',
'limits',
'requestDevice',
],
},
device: {
create(t: GPUTest) {
return t.device;
},
requiredKeys: [
'adapterInfo',
'addEventListener',
'createBindGroup',
'createBindGroupLayout',
'createBuffer',
'createCommandEncoder',
'createComputePipeline',
'createComputePipelineAsync',
'createPipelineLayout',
'createQuerySet',
'createRenderBundleEncoder',
'createRenderPipeline',
'createRenderPipelineAsync',
'createSampler',
'createShaderModule',
'createTexture',
'destroy',
'dispatchEvent',
'features',
'importExternalTexture',
'label',
'limits',
'lost',
'onuncapturederror',
'popErrorScope',
'pushErrorScope',
'queue',
'removeEventListener',
],
},
'adapter.limits': {
create(t: GPUTest) {
return t.adapter.limits;
},
requiredKeys: kLimits,
},
'device.limits': {
create(t: GPUTest) {
return t.device.limits;
},
requiredKeys: kLimits,
},
} as const;
const kResources = keysOf(kResourceInfo);
type ResourceName = (typeof kResources)[number];

function createResource(t: GPUTest, type: ResourceName) {
return kResourceInfo[type].create(t);
}

type Resource = ReturnType<typeof createResource>;

function forOfIterations(obj: Resource) {
let count = 0;
for (const _ of obj as unknown as []) {
++count;
}
return count;
}

function hasRequiredKeys(t: GPUTest, obj: Resource, requiredKeys: readonly string[]) {
for (const requiredKey of requiredKeys) {
t.expect(requiredKey in obj, `${requiredKey} in ${obj.constructor.name} exists`);
}
}

function aHasBElements(
t: GPUTest,
a: GPUSupportedFeatures | string[],
b: GPUSupportedFeatures | string[]
) {
for (const elem of b) {
if (Array.isArray(a)) {
t.expect(a.includes(elem), `missing ${elem}`);
} else if (a.has) {
t.expect(a.has(elem), `missing ${elem}`);
} else {
unreachable();
}
}
}

export const g = makeTestGroup(AllFeaturesTest);
g.test('obj,Object_keys')
.desc('tests returns nothing for Object.keys()')
.params(u => u.combine('type', kResources))
.fn(t => {
const { type } = t.params;
const obj = createResource(t, type);
t.expect(objectEquals([...Object.keys(obj)], []), `Object.keys([...${type}] === []`);
});

g.test('obj,spread')
.desc('does not spread')
.params(u => u.combine('type', kResources))
.fn(t => {
const { type } = t.params;
const obj = createResource(t, type);
t.expect(objectEquals({ ...obj }, {}), `{ ...${type} ] === {}`);
});

g.test('obj,for_in')
.desc('iterates over keys - for (key in object)')
.params(u => u.combine('type', kResources))
.fn(t => {
const { type } = t.params;
const obj = createResource(t, type);
hasRequiredKeys(t, obj, kResourceInfo[type].requiredKeys);
});

g.test('obj,for_of')
.desc('throws TypeError - for (key of object')
.params(u => u.combine('type', kResources))
.fn(t => {
const { type } = t.params;
const obj = createResource(t, type);
t.shouldThrow('TypeError', () => forOfIterations(obj), {
message: `for (key of ${type} } throws TypeError`,
});
});

g.test('obj,getOwnPropertyDescriptors')
.desc('Object.getOwnPropertyDescriptors returns {}')
.params(u => u.combine('type', kResources))
.fn(t => {
const { type } = t.params;
const obj = createResource(t, type);
t.expect(
objectEquals(Object.getOwnPropertyDescriptors(obj), {}),
`Object.getOwnPropertyDescriptors(${type}} === {}`
);
});

g.test('setlike,spread')
.desc('obj spreads')
.params(u => u.combine('type', ['adapter', 'device'] as const))
.fn(t => {
const { type } = t.params;
const obj = type === 'adapter' ? t.adapter : t.device;
const copy = [...obj.features];
aHasBElements(t, copy, obj.features);
aHasBElements(t, obj.features, copy);
});

g.test('setlike,set')
.desc('obj copies to set')
.params(u => u.combine('type', ['adapter', 'device'] as const))
.fn(t => {
const { type } = t.params;
const obj = type === 'adapter' ? t.adapter : t.device;
const copy = new Set(obj.features);
aHasBElements(t, copy, obj.features);
aHasBElements(t, obj.features, copy);
});

g.test('setlike,requiredFeatures')
.desc('can be passed as required features')
.params(u => u.combine('type', ['adapter', 'device'] as const))
.fn(async t => {
const { type } = t.params;
const obj = type === 'adapter' ? t.adapter : t.device;

const gpu = getGPU(null);
const adapter = await gpu.requestAdapter();
const device = await t.requestDeviceTracked(adapter!, {
requiredFeatures: obj.features as unknown as Iterable<GPUFeatureName>,
});
aHasBElements(t, device.features, obj.features);
aHasBElements(t, obj.features, device.features);
});

g.test('limits')
.desc('adapter/device.limits can not be passed as requiredLimits')
.params(u => u.combine('type', ['adapter', 'device'] as const))
.fn(async t => {
const { type } = t.params;
const obj = type === 'adapter' ? t.adapter : t.device;

const gpu = getGPU(null);
const adapter = await gpu.requestAdapter();
assert(!!adapter);
const device = await t.requestDeviceTracked(adapter, {
requiredLimits: obj.limits as unknown as Record<string, number>,
});
const defaultLimits = getDefaultLimitsForAdapter(adapter);
for (const [key, { default: defaultLimit }] of Object.entries(defaultLimits)) {
const actual = (device.limits as unknown as Record<string, number>)[key];
t.expect(
actual === defaultLimit,
`expected device.limits.${key}(${actual}) === ${defaultLimit}`
);
}
});

0 comments on commit 8ba8a9a

Please sign in to comment.