Skip to content

Commit

Permalink
Fixing percyScreenshotEnd response
Browse files Browse the repository at this point in the history
  • Loading branch information
@rishigupta1599
rishigupta1599 committed Nov 3, 2023
1 parent 4aaa7b2 commit 08a49fd
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 30 deletions.
10 changes: 5 additions & 5 deletions packages/webdriver-utils/src/providers/automateProvider.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export default class AutomateProvider extends GenericProvider {
error = e;
throw e;
} finally {
await this.percyScreenshotEnd(name, response?.body?.link, `${error}`);
await this.percyScreenshotEnd(name, error);
}
return response;
}
Expand All @@ -93,14 +93,14 @@ export default class AutomateProvider extends GenericProvider {
});
}

async percyScreenshotEnd(name, percyScreenshotUrl, statusMessage = null) {
async percyScreenshotEnd(name, error) {
return await TimeIt.run('percyScreenshotEnd', async () => {
try {
await this.browserstackExecutor('percyScreenshot', {
name,
percyScreenshotUrl,
status: percyScreenshotUrl ? 'success' : 'failure',
statusMessage,
percyScreenshotUrl: this.buildInfo.url,
status: error ? 'failure' : 'success',
statusMessage: error ? `${error}` : '',
state: 'end'
});
} catch (e) {
Expand Down
68 changes: 43 additions & 25 deletions packages/webdriver-utils/test/providers/automateProvider.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ describe('AutomateProvider', () => {
});

it('throws Error when called without initializing driver', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await expectAsync(automateProvider.browserstackExecutor('getSessionDetails'))
.toBeRejectedWithError('Driver is null, please initialize driver with createDriver().');
});

it('calls browserstackExecutor with correct arguemnts for actions only', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
await automateProvider.browserstackExecutor('getSessionDetails');
expect(executeScriptSpy)
.toHaveBeenCalledWith({ script: 'browserstack_executor: {"action":"getSessionDetails"}', args: [] });
});

it('calls browserstackExecutor with correct arguemnts for actions + args', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
await automateProvider.browserstackExecutor('getSessionDetails', 'new');
expect(executeScriptSpy)
Expand All @@ -65,7 +65,7 @@ describe('AutomateProvider', () => {
});

it('sets automate url', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
await automateProvider.screenshot('abc', { });

Expand All @@ -74,7 +74,7 @@ describe('AutomateProvider', () => {
});

it('throws error if driver is not initialized', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await expectAsync(automateProvider.setDebugUrl())
.toBeRejectedWithError('Driver is null, please initialize driver with createDriver().');
});
Expand Down Expand Up @@ -107,7 +107,7 @@ describe('AutomateProvider', () => {
id: '123',
url: 'https://percy.io/abc/123'
};
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);

beforeEach(async () => {
percyScreenshotBeginSpy = spyOn(AutomateProvider.prototype,
Expand All @@ -124,17 +124,17 @@ describe('AutomateProvider', () => {

expect(percyScreenshotBeginSpy).toHaveBeenCalledWith('abc');
expect(superScreenshotSpy).toHaveBeenCalledWith('abc', options);
expect(percyScreenshotEndSpy).toHaveBeenCalledWith('abc', 'link to screenshot', 'undefined');
expect(percyScreenshotEndSpy).toHaveBeenCalledWith('abc', undefined);
});

it('passes exception message to percyScreenshotEnd in case of exception', async () => {
await automateProvider.createDriver();
const errorMessage = 'Some error occured';
superScreenshotSpy.and.rejectWith(new Error(errorMessage));
percyScreenshotEndSpy.and.rejectWith(new Error(errorMessage));
await expectAsync(automateProvider.screenshot('abc', options)).toBeRejectedWithError(errorMessage);
const errorObj = new Error('Some error occured');
superScreenshotSpy.and.rejectWith(errorObj);
percyScreenshotEndSpy.and.rejectWith(errorObj);
await expectAsync(automateProvider.screenshot('abc', options)).toBeRejectedWith(errorObj);
expect(percyScreenshotBeginSpy).toHaveBeenCalledWith('abc');
expect(percyScreenshotEndSpy).toHaveBeenCalledWith('abc', undefined, `Error: ${errorMessage}`);
expect(percyScreenshotEndSpy).toHaveBeenCalledWith('abc', errorObj);
});
});

Expand All @@ -149,14 +149,14 @@ describe('AutomateProvider', () => {
});

it('supresses exception and does not throw', async () => {
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
automateProvider.driver.executeScript = jasmine.createSpy().and.rejectWith(new Error('Random network error'));
await automateProvider.percyScreenshotBegin('abc');
});

it('marks the percy session as success', async () => {
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
automateProvider.driver.executeScript = jasmine.createSpy().and.returnValue(Promise.resolve({ success: true }));
await automateProvider.percyScreenshotBegin('abc');
Expand All @@ -169,24 +169,42 @@ describe('AutomateProvider', () => {
id: '123',
url: 'https://percy.io/abc/123'
};
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);

let errorObj = new Error('Random network error');
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);

beforeEach(async () => {
spyOn(Driver.prototype, 'getCapabilites');
});

it('supresses exception and does not throw', async () => {
await automateProvider.createDriver();
automateProvider.driver = jasmine.createSpy().and.rejectWith(new Error('Random network error'));
await automateProvider.percyScreenshotEnd('abc', 'url');
automateProvider.driver = jasmine.createSpy().and.rejectWith(errorObj);
expect(async () => await automateProvider.percyScreenshotEnd('abc', errorObj)).not.toThrow();
});

it('marks status as failed if screenshot url is not present', async () => {
it('marks status as failed if error is present', async () => {
await automateProvider.createDriver();
automateProvider.driver.executeScript = jasmine.createSpy().and.rejectWith(new Error('Random network error'));
await automateProvider.percyScreenshotEnd('abc');
await automateProvider.percyScreenshotEnd('abc', errorObj);

expect(automateProvider.driver.executeScript).toHaveBeenCalledWith(
{
script: `browserstack_executor: {"action":"percyScreenshot","arguments":{"name":"abc","percyScreenshotUrl":"${percyBuildInfo.url}","status":"failure","statusMessage":"${errorObj}","state":"end"}}`,
args: []
});
});

expect(automateProvider.driver.executeScript).toHaveBeenCalledWith({ script: 'browserstack_executor: {"action":"percyScreenshot","arguments":{"name":"abc","status":"failure","statusMessage":null,"state":"end"}}', args: [] });
it('marks status as success if no error', async () => {
await automateProvider.createDriver();
automateProvider.driver.executeScript = jasmine.createSpy().and.resolveTo('success');
await automateProvider.percyScreenshotEnd('abc', undefined);

expect(automateProvider.driver.executeScript).toHaveBeenCalledWith(
{
script: `browserstack_executor: {"action":"percyScreenshot","arguments":{"name":"abc","percyScreenshotUrl":"${percyBuildInfo.url}","status":"success","statusMessage":"","state":"end"}}`,
args: []
});
});
});

Expand All @@ -197,7 +215,7 @@ describe('AutomateProvider', () => {
id: '123',
url: 'https://percy.io/abc/123'
};
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);

beforeEach(async () => {
spyOn(Driver.prototype, 'getCapabilites');
Expand Down Expand Up @@ -249,7 +267,7 @@ describe('AutomateProvider', () => {
};

describe('for desktop', () => {
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
beforeEach(async () => {
percyScreenshotBeginSpy = spyOn(AutomateProvider.prototype,
'percyScreenshotBegin').and.returnValue({ value: '{"buildHash":"12e3","sessionHash":"abc1d","capabilities":{"browserName":"chrome","browserVersion":"113.0","os":"win11","os_version":"11","deviceOrientation":false,"resolution":["1920","1080"]},"success":true,"deviceName":"x.x.x.x"}' });
Expand Down Expand Up @@ -287,7 +305,7 @@ describe('AutomateProvider', () => {
});

describe('for devices', () => {
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'android' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
const automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'android' }, {}, {}, 'client', 'environment', percyBuildInfo);
beforeEach(async () => {
percyScreenshotBeginSpy = spyOn(AutomateProvider.prototype,
'percyScreenshotBegin').and.returnValue({ value: '{"buildHash":"12e3","sessionHash":"abc1d","capabilities":{"browserName":"chrome_android","browserVersion":"chrome_android","os":"android","os_version":"11","deviceOrientation":"portrait","resolution":["1920","1080"]},"success":true,"deviceName":"Samsung Galaxy S21"}' });
Expand Down Expand Up @@ -326,15 +344,15 @@ describe('AutomateProvider', () => {

describe('driver is null', () => {
it('throws Error when called without initializing driver', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await expectAsync(automateProvider.getTag())
.toBeRejectedWithError('Driver is null, please initialize driver with createDriver().');
});
});

describe('automateResults is null', () => {
it('throws Error automateResults are not available', async () => {
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', {}, percyBuildInfo);
let automateProvider = new AutomateProvider('1234', 'https://localhost/command-executor', { platform: 'win' }, {}, {}, 'client', 'environment', percyBuildInfo);
await automateProvider.createDriver();
await expectAsync(automateProvider.getTag())
.toBeRejectedWithError('Comparison tag details not available');
Expand Down

0 comments on commit 08a49fd

Please sign in to comment.