Skip to content

Commit

Permalink
Add example for resulting comment (#14)
Browse files Browse the repository at this point in the history
* add example for resulting comment

* remove useless width attribute

* add a bit of padding

* add empty line because of alternating zebra stripes

* tiny text change

* add tests for index.js
  • Loading branch information
Primajin authored Jan 14, 2025
1 parent f39258d commit 38dc194
Show file tree
Hide file tree
Showing 2 changed files with 174 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,45 @@ For more examples, see the [workflow examples](.github/workflows).

## License
This project is licensed under the Unlicense license - see the [LICENSE](LICENSE) file for details.

## Comment

The comment will look something like this:

<table>
<tr>
<td colspan="2"></td>
</tr>
<tr>
<td><img src="https://avatars.githubusercontent.com/in/15368?s=80&v=4" alt="@github-actions" width="40" height="40" /></td>
<td><b>github-actions</b> (bot) commented 2 minutes ago &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
</tr>
<tr>
<td></td>
<td>

# Console Logs
## ❌ Error
```
This is an error
```
## ℹ️ Info
```
This is an info
This is a log
This is another log
```
## 💬 Verbose
```
This is a debug message
```
## ⚠️ Warning
```
This is a warning
```
</td>
</tr>
</table>
132 changes: 132 additions & 0 deletions index.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
import {promises as fs} from 'node:fs';
import {chromium} from 'playwright';
import {
describe, test, expect, vi, beforeEach, afterEach,
} from 'vitest';

vi.mock('playwright', () => ({
chromium: {
launch: vi.fn().mockResolvedValue({
newPage: vi.fn().mockResolvedValue({
on: vi.fn(),
goto: vi.fn(),
waitForTimeout: vi.fn(),
}),
close: vi.fn(),
}),
},
}));

vi.mock('node:fs', () => ({
promises: {
writeFile: vi.fn(),
},
}));

vi.mock('./utils.js', () => ({
filterMessage: vi.fn((level, message) => message),
shouldCapture: vi.fn(() => true),
shouldFail: vi.fn(() => false),
logLevels: ['verbose', 'info', 'warning', 'error'],
}));

describe('index.js', async () => {
let page;
let browser;

beforeEach(async () => {
browser = await chromium.launch();
page = await browser.newPage();
});

afterEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

test('should capture console messages and write to file', async () => {
const consoleMessages = new Map([
['info', ['Test message']],
]);

page.on.mockImplementation((event, callback) => {
if (event === 'console') {
callback({type: () => 'log', text: () => 'Test message'});
}
});

await import('./index.js');

expect(page.goto).toHaveBeenCalled();
expect(page.waitForTimeout).toHaveBeenCalled();
expect(fs.writeFile).toHaveBeenCalledWith('console_output.json', JSON.stringify(Object.fromEntries(consoleMessages), null, 2));
});

test('should handle different log levels', async () => {
const consoleMessages = new Map([
['error', ['Error message']],
]);

page.on.mockImplementation((event, callback) => {
if (event === 'console') {
callback({type: () => 'error', text: () => 'Error message'});
}
});

await import('./index.js');

expect(fs.writeFile).toHaveBeenCalledWith('console_output.json', JSON.stringify(Object.fromEntries(consoleMessages), null, 2));
});

test('should not capture empty console messages', async () => {
const consoleMessages = new Map([
['info', ['only one message should be there']],
]);

page.on.mockImplementation((event, callback) => {
if (event === 'console') {
callback({type: () => 'log', text: () => 'only one message should be there'});
callback({type: () => 'log', text: () => ''});
callback({type: () => 'log', text: () => ''});
callback({type: () => 'log', text: () => ''});
callback({type: () => 'log', text: () => ''});
callback({type: () => 'log', text: () => ''});
}
});

await import('./index.js');

expect(fs.writeFile).toHaveBeenCalledWith('console_output.json', JSON.stringify(Object.fromEntries(consoleMessages), null, 2));
});

test('should set shouldFailAction based on log level', async () => {
vi.mock('./utils.js', () => ({
filterMessage: vi.fn((level, message) => message),
shouldCapture: vi.fn(() => true),
shouldFail: vi.fn(level => level === 'error'),
logLevels: ['verbose', 'info', 'warning', 'error'],
}));

page.on.mockImplementation((event, callback) => {
if (event === 'console') {
callback({type: () => 'error', text: () => 'Error message'});
}
});

await import('./index.js');

expect(fs.writeFile).toHaveBeenCalled();
expect(process.env.SHOULD_FAIL_ACTION).toBe('true');
});

test('should handle different environment variables', async () => {
process.env.PORT = '3000';
process.env.WAIT_TIME = '1000';
process.env.WEBAPP_URL = 'http://example.com';

await import('./index.js');

expect(page.goto).toHaveBeenCalledWith('http://example.com:3000');
expect(page.waitForTimeout).toHaveBeenCalledWith(1000);
});
});

0 comments on commit 38dc194

Please sign in to comment.