Skip to content

Commit

Permalink
feat(facade): add test for worksheet facade
Browse files Browse the repository at this point in the history
  • Loading branch information
@Dushusir
Dushusir committed Aug 27, 2024
1 parent 6ba26fa commit 583fe03
Show file tree
Hide file tree
Showing 6 changed files with 673 additions and 128 deletions.
86 changes: 2 additions & 84 deletions examples/src/sheets/main.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import { UniverSheetsDrawingUIPlugin } from '@univerjs/sheets-drawing-ui';
import { UniverDocsHyperLinkPlugin } from '@univerjs/docs-hyper-link';

import { enUS, ruRU, viVN, zhCN, zhTW } from '../locales';
import { DEFAULT_WORKBOOK_DATA_DEMO } from '../data/sheets/demo/default-workbook-data-demo';

/* eslint-disable-next-line node/prefer-global/process */
const IS_E2E: boolean = !!process.env.IS_E2E;
Expand Down Expand Up @@ -138,90 +139,7 @@ userManagerService.setCurrentUser(mockUser);

// create univer sheet instance
if (!IS_E2E) {
univer.createUnit(UniverInstanceType.UNIVER_SHEET, {
id: 'test',
appVersion: '3.0.0-alpha',
sheets: {
// 1
// 2-3-
// 4
// |
sheet1: {
id: 'sheet1',
cellData: {
0: {
0: {
v: 'A1',
s: 's1',
},
},
1: {
1: {
v: 'B2',
s: 's2',
},
4: {
v: 'E2',
s: 's3',
},
},
2: {
1: {
v: 'B3',
s: 's4',
},
},
3: {
1: {
v: 1,
},
},
4: {
1: {
v: 2,
},
},
5: {
1: {
v: 3,
},
},
},
mergeData: [
{ startRow: 1, endRow: 1, startColumn: 2, endColumn: 3 },
{
startRow: 2,
endRow: 3,
startColumn: 2,
endColumn: 2,
},
{
startRow: 10,
endRow: 15,
startColumn: 2,
endColumn: 2,
},
{
startRow: 10,
endRow: 10,
startColumn: 10,
endColumn: 15,
},
],
rowCount: 20,
columnCount: 20,
},
},
locale: LocaleType.ZH_CN,
name: '',
sheetOrder: [],
styles: {
s1: { bg: { rgb: '#00ff00' } },
s2: { bl: 0 },
s3: { bl: 1 },
s4: { fs: 12, bg: { rgb: '#ff0000' } },
},
});
univer.createUnit(UniverInstanceType.UNIVER_SHEET, DEFAULT_WORKBOOK_DATA_DEMO);
}

setTimeout(() => {
Expand Down
234 changes: 234 additions & 0 deletions packages/facade/src/apis/sheets/__tests__/create-worksheet-test-bed.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
/**
* Copyright 2023-present DreamNum Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/* eslint-disable max-lines-per-function */

import type { Dependency, IWorkbookData, UnitModel } from '@univerjs/core';
import {
ILogService,
Inject,
Injector,
IUniverInstanceService,
LocaleService,
LocaleType,
LogLevel,
Plugin,
ThemeService,
Univer,
UniverInstanceType,
} from '@univerjs/core';
import { ActiveDirtyManagerService, FormulaDataModel, FunctionService, IActiveDirtyManagerService, IFunctionService, LexerTreeBuilder } from '@univerjs/engine-formula';
import { ISocketService, WebSocketService } from '@univerjs/network';
import {
RangeProtectionRuleModel,
RefRangeService,
SheetInterceptorService,
SheetsSelectionsService,
WorkbookPermissionService,
WorksheetPermissionService,
WorksheetProtectionPointModel,
WorksheetProtectionRuleModel,
} from '@univerjs/sheets';
import {
DescriptionService,
IDescriptionService,
IRegisterFunctionService,
RegisterFunctionService,
RegisterOtherFormulaService,
} from '@univerjs/sheets-formula';
import enUS from '@univerjs/sheets-formula/locale/en-US';
import zhCN from '@univerjs/sheets-formula/locale/zh-CN';

import { Engine, IRenderingEngine, IRenderManagerService, RenderManagerService } from '@univerjs/engine-render';
import { ISheetSelectionRenderService, SheetRenderController, SheetSelectionRenderService, SheetSkeletonManagerService, SheetsRenderService } from '@univerjs/sheets-ui';
import { IPlatformService, IShortcutService, PlatformService, ShortcutService } from '@univerjs/ui';
import { ConditionalFormattingFormulaService, ConditionalFormattingRuleModel, ConditionalFormattingService, ConditionalFormattingViewModel } from '@univerjs/sheets-conditional-formatting';
import { UniverDataValidationPlugin } from '@univerjs/data-validation';
import { DataValidationCacheService, DataValidationCustomFormulaService, DataValidationFormulaService, DataValidationModel, SheetDataValidationManager, SheetsDataValidationValidatorService } from '@univerjs/sheets-data-validation';
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter';
import { FUniver } from '../../facade';

function getTestWorkbookDataDemo(): IWorkbookData {
return {
id: 'test',
appVersion: '3.0.0-alpha',
sheets: {
sheet1: {
id: 'sheet1',
name: 'sheet1',
cellData: {
0: {
0: {
v: 1,
},
},
1: {
0: {
v: 2,
},
},
2: {
0: {
v: 3,
},
},
3: {
0: {
v: 4,
},
},
},
rowCount: 100,
columnCount: 100,
},
},
locale: LocaleType.ZH_CN,
name: '',
sheetOrder: [],
styles: {},
resources: [
{
name: 'SHEET_CONDITIONAL_FORMATTING_PLUGIN',
data: '{"sheet-0011":[{"cfId":"AEGZdW8C","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"4ICEXdJj","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"geCv018z","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false}]}',
},
],
};
}

export interface ITestBed {
univer: Univer;
get: Injector['get'];
sheet: UnitModel<IWorkbookData>;
univerAPI: FUniver;
injector: Injector;
}

export function createWorksheetTestBed(workbookData?: IWorkbookData, dependencies?: Dependency[]): ITestBed {
const univer = new Univer();
const injector = univer.__getInjector();

class TestPlugin extends Plugin {
static override pluginName = 'test-plugin';
static override type = UniverInstanceType.UNIVER_SHEET;

constructor(
_config: undefined,
@Inject(Injector) override readonly _injector: Injector
) {
super();
}

override onStarting(): void {
const injector = this._injector;
injector.add([SheetsSelectionsService]);
injector.add([SheetInterceptorService]);
injector.add([IRegisterFunctionService, { useClass: RegisterFunctionService }]);
injector.add([
IDescriptionService,
{
useFactory: () => this._injector.createInstance(DescriptionService, undefined),
},
]);

injector.add([IFunctionService, { useClass: FunctionService }]);
injector.add([ISocketService, { useClass: WebSocketService }]);
injector.add([IRenderingEngine, { useFactory: () => new Engine() }]);
injector.add([IRenderManagerService, { useClass: RenderManagerService }]);
injector.add([ISheetSelectionRenderService, { useClass: SheetSelectionRenderService }]);
injector.add([SheetsRenderService]);
injector.add([IShortcutService, { useClass: ShortcutService }]);
injector.add([IPlatformService, { useClass: PlatformService }]);
injector.add([SheetSkeletonManagerService]);
injector.add([FormulaDataModel]);
injector.add([LexerTreeBuilder]);
injector.add([RefRangeService]);
injector.add([WorksheetPermissionService]);
injector.add([WorkbookPermissionService]);
injector.add([WorksheetProtectionPointModel]);
injector.add([RangeProtectionRuleModel]);
injector.add([WorksheetProtectionRuleModel]);

const renderManagerService = injector.get(IRenderManagerService);
renderManagerService.registerRenderModule(UniverInstanceType.UNIVER_SHEET, [SheetSkeletonManagerService] as Dependency);
renderManagerService.registerRenderModule(UniverInstanceType.UNIVER_SHEET, [SheetRenderController] as Dependency);

// register feature modules
([
// conditional formatting
[ConditionalFormattingService],
[ConditionalFormattingFormulaService],
[ConditionalFormattingRuleModel],
[ConditionalFormattingViewModel],

// data validation
[DataValidationCacheService],
[DataValidationFormulaService],
[DataValidationCustomFormulaService],
[RegisterOtherFormulaService],
[IActiveDirtyManagerService, { useClass: ActiveDirtyManagerService }],
[SheetsDataValidationValidatorService],

// sheets filter
] as Dependency[]).forEach((d) => {
injector.add(d);
});

dependencies?.forEach((d) => injector.add(d));
}
}

// load i18n
injector.get(LocaleService).load({ zhCN, enUS });

// load theme service
const themeService = injector.get(ThemeService);
themeService.setTheme({ colorBlack: '#35322b' });

// register builtin plugins
// note that UI plugins are not registered here, because the unit test environment does not have a UI
univer.registerPlugin(TestPlugin);
univer.registerPlugin(UniverSheetsFilterPlugin);
univer.registerPlugin(UniverDataValidationPlugin);

const sheet = univer.createUnit<IWorkbookData, UnitModel<IWorkbookData>>(UniverInstanceType.UNIVER_SHEET, workbookData || getTestWorkbookDataDemo());
const univerInstanceService = injector.get(IUniverInstanceService);
univerInstanceService.focusUnit('test');

// set log level
const logService = injector.get(ILogService);
logService.setLogLevel(LogLevel.SILENT); // NOTE: change this to `LogLevel.VERBOSE` to debug tests via logs

// init data validation
const createSheetDataValidationManager = (unitId: string, subUnitId: string) => {
return new SheetDataValidationManager(
unitId,
subUnitId,
injector
);
};
const dataValidationModel = injector.get(DataValidationModel);
dataValidationModel.setManagerCreator(createSheetDataValidationManager);

const univerAPI = FUniver.newAPI(injector);

return {
univer,
get: injector.get.bind(injector),
sheet,
univerAPI,
injector,
};
}
Loading

0 comments on commit 583fe03

Please sign in to comment.