Skip to content

Commit

Permalink
Feature: report on devices (#477)
Browse files Browse the repository at this point in the history
  • Loading branch information
@emmercm
emmercm authored Jul 13, 2023
1 parent 51096a0 commit 51a5c42
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 28 deletions.
5 changes: 5 additions & 0 deletions src/types/datStatus.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import ReleaseCandidate from './releaseCandidate.js';
enum ROMType {
GAME = 'games',
BIOS = 'BIOSes',
DEVICE = 'devices',
RETAIL = 'retail releases',
PATCHED = 'patched games',
}
Expand Down Expand Up @@ -84,6 +85,9 @@ export default class DATStatus {
if (game.isBios()) {
DATStatus.append(map, ROMType.BIOS, value);
}
if (game.isDevice()) {
DATStatus.append(map, ROMType.DEVICE, value);
}
if (game.isRetail()) {
DATStatus.append(map, ROMType.RETAIL, value);
}
Expand Down Expand Up @@ -269,6 +273,7 @@ export default class DATStatus {
!options.getSingle() && !options.getOnlyBios() && !options.getOnlyRetail()
? ROMType.GAME : undefined,
options.getOnlyBios() || !options.getNoBios() ? ROMType.BIOS : undefined,
!options.getNoDevice() && !options.getOnlyBios() ? ROMType.DEVICE : undefined,
options.getOnlyRetail() || !options.getOnlyBios() ? ROMType.RETAIL : undefined,
ROMType.PATCHED,
].filter((romType) => romType) as ROMType[];
Expand Down
96 changes: 68 additions & 28 deletions test/modules/statusGenerator.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const gameNameBios = 'bios';
const gameNamePrototype = 'game prototype (proto)';
const gameNameSingleRom = 'game with single rom';
const gameNameMultipleRoms = 'game with multiple roms';
const gameNameDevice = 'device';

const defaultOptions: OptionsProps = {
dat: [''], // force "is using DATs"
Expand Down Expand Up @@ -51,8 +52,15 @@ const dat = new DAT(new Header({
new ROM('two.rom', 123, '55555555'),
],
}),
new Game({
name: gameNameDevice,
device: 'yes',
// (a game can't count as "missing" if it has no ROMs)
}),
]);

// TODO(cemmer): this should filter the candidates before generating statuses

async function getParentToReleaseCandidates(
parentName: string,
): Promise<[Parent, ReleaseCandidate[]]> {
Expand All @@ -72,68 +80,75 @@ async function getParentToReleaseCandidates(

describe('toConsole', () => {
describe('no candidates', () => {
it('should return games, BIOSes, and retail as missing', async () => {
it('should print games without ROMs as found', async () => {
const options = new Options(defaultOptions);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
expect(stripAnsi(datStatus.toConsole(options))).toEqual('1/5 games, 0/1 BIOSes, 1/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/6 games, 0/1 BIOSes, 1/1 devices, 2/5 retail releases found');
});

it('should return games and retail as missing', async () => {
it('should not print game count when single:true', async () => {
const options = new Options({ ...defaultOptions, single: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
expect(stripAnsi(datStatus.toConsole(options))).toEqual('0/1 BIOSes, 1/1 devices, 2/5 retail releases found');
});

it('should not print BIOS count when noBios:true', async () => {
const options = new Options({ ...defaultOptions, noBios: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
expect(stripAnsi(datStatus.toConsole(options))).toEqual('1/5 games, 1/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/6 games, 1/1 devices, 2/5 retail releases found');
});

it('should return BIOSes as missing', async () => {
it('should only print BIOS count when onlyBios:true', async () => {
const options = new Options({ ...defaultOptions, onlyBios: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
expect(stripAnsi(datStatus.toConsole(options))).toEqual('0/1 BIOSes found');
});

it('should return BIOSes and retail as missing', async () => {
const options = new Options({ ...defaultOptions, single: true });
it('should not print device count when noDevice:true', async () => {
const options = new Options({ ...defaultOptions, noDevice: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
expect(stripAnsi(datStatus.toConsole(options))).toEqual('0/1 BIOSes, 1/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/6 games, 0/1 BIOSes, 2/5 retail releases found');
});
});

describe('partially missing', () => {
it('should return bios as found', async () => {
it('should print games without ROMS and BIOSes as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameBios),
]);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, map);
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/5 games, 1/1 BIOSes, 2/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('3/6 games, 1/1 BIOSes, 1/1 devices, 3/5 retail releases found');
});

it('should return prototype as found', async () => {
it('should print prototypes as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNamePrototype),
]);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, map);
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/5 games, 0/1 BIOSes, 1/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('3/6 games, 0/1 BIOSes, 1/1 devices, 2/5 retail releases found');
});

it('should return game with single rom as found', async () => {
it('should print the game with single rom as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameSingleRom),
]);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, map);
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/5 games, 0/1 BIOSes, 2/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('3/6 games, 0/1 BIOSes, 1/1 devices, 3/5 retail releases found');
});
});

it('should return patched game as found', async () => {
it('should always print patched games as found', async () => {
const game = new Game({ name: 'patched game' });
const rom = new ROM('patched.rom', 123, '00000000');
const map = new Map([[
Expand All @@ -148,10 +163,10 @@ describe('toConsole', () => {
const options = new Options(defaultOptions);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, map);
expect(stripAnsi(datStatus.toConsole(options))).toEqual('1/5 games, 0/1 BIOSes, 1/4 retail releases, 1 patched games found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('2/6 games, 0/1 BIOSes, 1/1 devices, 2/5 retail releases, 1 patched games found');
});

it('should return none missing', async () => {
it('should print every game as found when all are present', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameBios),
Expand All @@ -161,58 +176,78 @@ describe('toConsole', () => {
]);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, map);
expect(stripAnsi(datStatus.toConsole(options))).toEqual('5/5 games, 1/1 BIOSes, 4/4 retail releases found');
expect(stripAnsi(datStatus.toConsole(options))).toEqual('6/6 games, 1/1 BIOSes, 1/1 devices, 5/5 retail releases found');
});
});

describe('toCSV', () => {
describe('no candidates', () => {
it('should return games, BIOSes, and retail as missing', async () => {
it('should report games without ROMs as found', async () => {
const options = new Options(defaultOptions);
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});

it('should return games and retail as missing', async () => {
// TODO(cemmer): this isn't reporting on the prototype game because ROMType.Game is excluded for
// single:true. We probably to fix this, I doubt the CSV is only including parents in 1G1R.
it('should report games without ROMs as found when single:true', async () => {
const options = new Options({ ...defaultOptions, single: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});

// TODO(cemmer): this is wrong, it's reporting the BIOS when noBios:true.
it('should not report BIOSes when noBios:true', async () => {
const options = new Options({ noBios: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});

it('should return BIOSes as missing', async () => {
it('should only report BIOSes when onlyBios:true', async () => {
const options = new Options({ ...defaultOptions, onlyBios: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false`);
});

it('should return BIOSes and retail as missing', async () => {
const options = new Options({ ...defaultOptions, single: true });
// TODO(cemmer): this is wrong, it's reporting the BIOS when noDevice:true.
it('should not report devices when noDevice:true', async () => {
const options = new Options({ ...defaultOptions, noDevice: true });
const datStatus = await new StatusGenerator(options, new ProgressBarFake())
.generate(dat, new Map());
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});
});

describe('partially missing', () => {
it('should return bios as found', async () => {
it('should report the BIOS as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameBios),
Expand All @@ -221,13 +256,14 @@ dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,fa
.generate(dat, map);
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,FOUND,bios.rom,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});

it('should return prototype as found', async () => {
it('should report the prototype as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNamePrototype),
Expand All @@ -236,13 +272,14 @@ dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,fa
.generate(dat, map);
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),FOUND,game prototype (proto).rom,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});

it('should return game with single rom as found', async () => {
it('should report the game with a single ROM as found', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameSingleRom),
Expand All @@ -251,14 +288,15 @@ dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,fa
.generate(dat, map);
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,FOUND,game.rom,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false`);
});
});

it('should return patched game as found', async () => {
it('should always report patched games as found', async () => {
const game = new Game({ name: 'patched game' });
const rom = new ROM('patched.rom', 123, '00000000');
const map = new Map([[
Expand All @@ -275,14 +313,15 @@ dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,fa
.generate(dat, map);
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,MISSING,,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),MISSING,,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,MISSING,,false,false,true,false,false,false,false,false,false,false,false,false
dat,no roms,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,patched game,FOUND,patched.rom,true,false,true,false,false,false,false,false,false,false,false,false`);
});

it('should return none missing', async () => {
it('should report every game as found when all are present', async () => {
const options = new Options(defaultOptions);
const map = new Map([
await getParentToReleaseCandidates(gameNameBios),
Expand All @@ -294,6 +333,7 @@ dat,patched game,FOUND,patched.rom,true,false,true,false,false,false,false,false
.generate(dat, map);
await expect(datStatus.toCsv(options)).resolves.toEqual(`DAT Name,Game Name,Status,ROM Files,Patched,BIOS,Retail Release,Unlicensed,Demo,Beta,Sample,Prototype,Test,Aftermarket,Homebrew,Bad
dat,bios,FOUND,bios.rom,false,true,true,false,false,false,false,false,false,false,false,false
dat,device,FOUND,,false,false,true,false,false,false,false,false,false,false,false,false
dat,game prototype (proto),FOUND,game prototype (proto).rom,false,false,false,false,false,false,false,true,false,false,false,false
dat,game with multiple roms,FOUND,"one.rom|two.rom",false,false,true,false,false,false,false,false,false,false,false,false
dat,game with single rom,FOUND,game.rom,false,false,true,false,false,false,false,false,false,false,false,false
Expand Down

0 comments on commit 51a5c42

Please sign in to comment.