paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

techdocs-common: avoid global type declarations

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-10-17 15:25:57 +02:00
parent 99563aacb3
commit b81299a332
12 changed files with 73 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-common/__mocks__/@azure/storage-blob.ts
+2 -1
View File
@@ -18,8 +18,9 @@ import {
ContainerGetPropertiesResponse,
} from '@azure/storage-blob';
import { EventEmitter } from 'events';
import { IStorageFilesMock } from '../../src/testUtils/types';
const storage = global.storageFilesMock;
const storage = global.storageFilesMock as IStorageFilesMock;
export class BlockBlobClient {
private readonly blobName;
packages/techdocs-common/__mocks__/@google-cloud/storage.ts
+2 -1
View File
@@ -14,8 +14,9 @@
* limitations under the License.
*/
import { Readable } from 'stream';
import { IStorageFilesMock } from '../../src/testUtils/types';
const storage = global.storageFilesMock;
const storage = global.storageFilesMock as IStorageFilesMock;
class GCSFile {
private readonly path: string;
packages/techdocs-common/__mocks__/aws-sdk.ts
+2 -1
View File
@@ -15,10 +15,11 @@
*/
import { EventEmitter } from 'events';
import { ReadStream } from 'fs';
import { IStorageFilesMock } from '../src/testUtils/types';
export { Credentials } from 'aws-sdk';
const storage = global.storageFilesMock;
const storage = global.storageFilesMock as IStorageFilesMock;
export class S3 {
constructor() {
packages/techdocs-common/__mocks__/globals.d.ts
Vendored
-22
View File
@@ -1,22 +0,0 @@
/*
* Copyright 2020 The Backstage Authors
*
* 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.
*/
declare module NodeJS {
interface Global {
rootDir: string;
storageFilesMock: IStorageFilesMock;
}
}
packages/techdocs-common/src/globals.d.ts
Vendored
-22
View File
@@ -1,22 +0,0 @@
/*
* Copyright 2020 The Backstage Authors
*
* 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.
*/
declare module NodeJS {
interface Global {
rootDir: string;
storageFilesMock: IStorageFilesMock;
}
}
packages/techdocs-common/src/setupTests.ts
+3 -43
View File
@@ -14,47 +14,7 @@
* limitations under the License.
*/
import os from 'os';
import path from 'path';
import fs from 'fs-extra';
import { StorageFilesMock } from './testUtils/StorageFilesMock';
const rootDir: string = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
const encoding = 'utf8';
class StorageFilesMock implements IStorageFilesMock {
private files: Record<string, string>;
constructor() {
this.files = {};
}
public emptyFiles(): void {
this.files = {};
}
public fileExists(targetPath: string): boolean {
const filePath = path.join(rootDir, targetPath);
const posixPath = filePath.split(path.posix.sep).join(path.sep);
return this.files[posixPath] !== undefined;
}
public readFile(targetPath: string): Buffer {
const filePath = path.join(rootDir, targetPath);
return Buffer.from(this.files[filePath] ?? '', encoding);
}
public writeFile(targetPath: string, sourcePath: string): void;
public writeFile(targetPath: string, sourceBuffer: Buffer): void;
public writeFile(targetPath: string, source: string | Buffer): void {
const filePath = path.join(rootDir, targetPath);
if (typeof source === 'string') {
this.files[filePath] = fs.readFileSync(source).toString(encoding);
} else {
this.files[filePath] = source.toString(encoding);
}
}
}
global.rootDir = rootDir;
global.storageFilesMock = new StorageFilesMock();
(global as any).rootDir = StorageFilesMock.rootDir;
(global as any).storageFilesMock = new StorageFilesMock();
packages/techdocs-common/src/stages/publish/awsS3.test.ts
+1 -1
View File
@@ -26,7 +26,7 @@ import { AwsS3Publish } from './awsS3';
// NOTE: /packages/techdocs-common/__mocks__ is being used to mock aws-sdk client library
const rootDir = global.rootDir;
const rootDir = (global as any).rootDir; // Set by setupTests.ts
const getEntityRootDir = (entity: Entity) => {
const {
packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts
+1 -1
View File
@@ -26,7 +26,7 @@ import { AzureBlobStoragePublish } from './azureBlobStorage';
// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Azure client library
const rootDir = global.rootDir;
const rootDir = (global as any).rootDir; // Set by setupTests.ts
const getEntityRootDir = (entity: Entity) => {
const {
packages/techdocs-common/src/stages/publish/googleStorage.test.ts
+1 -1
View File
@@ -26,7 +26,7 @@ import { GoogleGCSPublish } from './googleStorage';
// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Google Cloud Storage client library
const rootDir = global.rootDir;
const rootDir = (global as any).rootDir; // Set by setupTests.ts
const getEntityRootDir = (entity: Entity) => {
const {
packages/techdocs-common/src/testUtils/StorageFilesMock.ts
+60
View File
@@ -0,0 +1,60 @@
/*
* Copyright 2020 The Backstage Authors
*
* 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.
*/
import os from 'os';
import path from 'path';
import fs from 'fs-extra';
import { IStorageFilesMock } from './types';
const rootDir: string = os.platform() === 'win32' ? 'C:\\rootDir' : '/rootDir';
const encoding = 'utf8';
export class StorageFilesMock implements IStorageFilesMock {
static rootDir = rootDir;
private files: Record<string, string>;
constructor() {
this.files = {};
}
public emptyFiles(): void {
this.files = {};
}
public fileExists(targetPath: string): boolean {
const filePath = path.join(rootDir, targetPath);
const posixPath = filePath.split(path.posix.sep).join(path.sep);
return this.files[posixPath] !== undefined;
}
public readFile(targetPath: string): Buffer {
const filePath = path.join(rootDir, targetPath);
return Buffer.from(this.files[filePath] ?? '', encoding);
}
public writeFile(targetPath: string, sourcePath: string): void;
public writeFile(targetPath: string, sourceBuffer: Buffer): void;
public writeFile(targetPath: string, source: string | Buffer): void {
const filePath = path.join(rootDir, targetPath);
if (typeof source === 'string') {
this.files[filePath] = fs.readFileSync(source).toString(encoding);
} else {
this.files[filePath] = source.toString(encoding);
}
}
}
packages/techdocs-common/__mocks__/types.d.ts → packages/techdocs-common/src/testUtils/types.ts
+1 -1
View File
@@ -14,7 +14,7 @@
* limitations under the License.
*/
interface IStorageFilesMock {
export interface IStorageFilesMock {
emptyFiles(): void;
fileExists(targetPath: string): boolean;
readFile(targetPath: string): Buffer;
packages/techdocs-common/src/types.d.ts
Vendored
-24
View File
@@ -1,24 +0,0 @@
/*
* Copyright 2020 The Backstage Authors
*
* 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.
*/
interface IStorageFilesMock {
emptyFiles(): void;
fileExists(targetPath: string): boolean;
readFile(targetPath: string): Buffer;
writeFile(targetPath: string, sourcePath: string): void;
writeFile(targetPath: string, sourceBuffer: Buffer): void;
writeFile(targetPath: string, source: string | Buffer): void;
}