Skip to content

Commit

Permalink
chore: rename repository links
Browse files Browse the repository at this point in the history
  • Loading branch information
KuznetsovRoman committed Apr 1, 2024
1 parent 59409a5 commit 9eedbdd
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
* Tests must pass.
* Follow our coding style (eslint will help you).
* If you fix a bug, add a test.
* If you can't fix a bug, file an [issue](https://github.com/gemini-testing/hermione/issues) with the steps to reproduce, the expected and the actual results.
* If you can't fix a bug, file an [issue](https://github.com/gemini-testing/testplane/issues) with the steps to reproduce, the expected and the actual results.
* if an issue desribes a problem which we are unable to reproduce and issue reporter does not answer our questions for 1 week, then this issue may be closed without further investigation.

## How to develop
### Create your own copy
```
git clone https://github.com/gemini-testing/hermione.git
cd hermione
git clone https://github.com/gemini-testing/testplane.git
cd testplane
npm install
```

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ All work with the grid client is encapsulated in hermione. Forget about `client.
Request `/session/:sessionId/orientation` is not a part of the official Webdriver specification, so commands `orientation` and `setOrientation` which are provided by client `webdriverio` from the box do not guarantee screen rotate before the next command will start to execute, but `Hermione` solves this problem.

## Prerequisites
All you need are browsers that `Hermione` could use for testing. To do this you need to install some browsers, such as [chrome](https://www.google.com/chrome/) (to automate this process you can use the [hermione-headless-chrome](https://github.com/gemini-testing/hermione-headless-chrome) plugin).
All you need are browsers that `Hermione` could use for testing. To do this you need to install some browsers, such as [chrome](https://www.google.com/chrome/) (to automate this process you can use the [hermione-headless-chrome](https://github.com/gemini-testing/testplane-headless-chrome) plugin).

Next, you have two ways to configure `Hermione` to work with browsers:

Expand Down Expand Up @@ -387,7 +387,7 @@ Write your first test in `tests/desktop/github.hermione.js` file.
```javascript
describe('github', function() {
it('should check repository name', async ({ browser }) => {
await browser.url('https://github.com/gemini-testing/hermione');
await browser.url('https://github.com/gemini-testing/testplane');

await expect(browser.$('#readme h1')).toHaveText('Hermione');
});
Expand All @@ -411,7 +411,7 @@ Browser command that clears session state (deletes cookies, clears local and ses

```js
it('test', async ({ browser }) => {
await browser.url('https://github.com/gemini-testing/hermione');
await browser.url('https://github.com/gemini-testing/testplane');

(await browser.getCookies()).length; // 5
await browser.execute(() => localStorage.length); // 2
Expand Down Expand Up @@ -1164,7 +1164,7 @@ buildDiffOpts: {
```

#### assertViewOpts
Default options used when calling [assertView](https://github.com/gemini-testing/hermione/#assertview), can be overridden by `assertView` options. Default values are:
Default options used when calling [assertView](https://github.com/gemini-testing/testplane/#assertview), can be overridden by `assertView` options. Default values are:
```javascript
ignoreElements: [],
captureElementFromTop: true,
Expand All @@ -1174,7 +1174,7 @@ Default options used when calling [assertView](https://github.com/gemini-testing
```

#### openAndWaitOpts
Default options used when calling [openAndWait](https://github.com/gemini-testing/hermione/#openandwait), can be overriden by `openAndWait` options. Default values are:
Default options used when calling [openAndWait](https://github.com/gemini-testing/testplane/#openandwait), can be overriden by `openAndWait` options. Default values are:
```javascript
waitNetworkIdle: true,
waitNetworkIdleTimeout: 500,
Expand Down Expand Up @@ -1219,7 +1219,7 @@ Available options:

Some plugins can rely on this history, for instance:
- [html-reporter](https://github.com/gemini-testing/html-reporter)
- [hermione-profiler](https://github.com/gemini-testing/hermione-profiler)
- [hermione-profiler](https://github.com/gemini-testing/testplane-profiler)

The history is available from such events: `TEST_END`, `TEST_PASS`, `TEST_FAIL` through payload:
```js
Expand Down Expand Up @@ -1347,7 +1347,7 @@ By default, `hermione` will run all browsers simultaneously. Sometimes (i.e. whe
Ability to set file extensions, which hermione will search on the file system. Default value is `[.js]`.

### plugins
`Hermione` plugins are commonly used to extend built-in functionality. For example, [html-reporter](https://github.com/gemini-testing/html-reporter) and [hermione-safari-commands](https://github.com/gemini-testing/hermione-safari-commands).
`Hermione` plugins are commonly used to extend built-in functionality. For example, [html-reporter](https://github.com/gemini-testing/html-reporter) and [hermione-safari-commands](https://github.com/gemini-testing/testplane-safari-commands).

A plugin is a module that exports a single function. The function has two arguments:

Expand Down Expand Up @@ -1587,8 +1587,8 @@ module.exports = {
There are several plugins that may be useful:

* [html-reporter](https://github.com/gemini-testing/html-reporter)
* [hermione-safari-commands](https://github.com/gemini-testing/hermione-safari-commands)
* [hermione-headless-chrome](https://github.com/gemini-testing/hermione-headless-chrome)
* [hermione-safari-commands](https://github.com/gemini-testing/testplane-safari-commands)
* [hermione-headless-chrome](https://github.com/gemini-testing/testplane-headless-chrome)
* ...and many others that you can find in [gemini-testing](https://github.com/search?q=topic%3Ahermione-plugin+org%3Agemini-testing&type=Repositories).

### prepareBrowser
Expand Down
8 changes: 4 additions & 4 deletions src/browser/commands/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { AssertViewOptsConfig } from "../../config/types";
export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
/**
* Maximum allowed difference between colors.
* Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#tolerance tolerance} value.
* Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#tolerance tolerance} value.
*
* @remarks
* Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode.
Expand All @@ -15,7 +15,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
tolerance?: number;
/**
* Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels.
* Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#antialiasingTolerance antialiasingTolerance} value.
* Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#antialiasingTolerance antialiasingTolerance} value.
*
* @remarks
* Read more about this option in {@link https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing looks-same}
Expand All @@ -25,7 +25,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
antialiasingTolerance?: number;
/**
* Allows testing of regions which bottom bounds are outside of a viewport height.
* Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#compositeImage compositeImage} value.
* Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#compositeImage compositeImage} value.
*
* @remarks
* In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height.
Expand All @@ -35,7 +35,7 @@ export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
compositeImage?: boolean;
/**
* Allows to specify a delay (in milliseconds) before making any screenshot.
* Overrides config {@link https://github.com/gemini-testing/hermione#browsers browsers}.{@link https://github.com/gemini-testing/hermione#screenshotDelay screenshotDelay} value.
* Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#screenshotDelay screenshotDelay} value.
*
* @remarks
* This is useful when the page has elements which are animated or if you do not want to screen a scrollbar.
Expand Down
6 changes: 3 additions & 3 deletions src/browser/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ declare global {
* Takes a screenshot of the passed selector and compares the received screenshot with the reference.
*
* @remarks
* For more details, see {@link https://github.com/gemini-testing/hermione#assertview documentation}.
* For more details, see {@link https://github.com/gemini-testing/testplane#assertview documentation}.
*
* @example
* ```ts
Expand Down Expand Up @@ -102,7 +102,7 @@ declare global {
* Command that allows to add human-readable description for commands in history
*
* @remarks
* For more details, see {@link https://github.com/gemini-testing/hermione#runstep documentation}
* For more details, see {@link https://github.com/gemini-testing/testplane#runstep documentation}
*
* @example
* ```ts
Expand Down Expand Up @@ -143,7 +143,7 @@ declare global {
* Takes a screenshot of the element and compares the received screenshot with the reference.
*
* @remarks
* For more details, see {@link https://github.com/gemini-testing/hermione#assertview documentation}.
* For more details, see {@link https://github.com/gemini-testing/testplane#assertview documentation}.
*
* @example
* ```ts
Expand Down
4 changes: 2 additions & 2 deletions src/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ export interface AssertViewOptsConfig {
* @remarks
* By default Hermione throws an error if element is outside the viewport bounds.
* This option disables check that element is outside of the viewport left, top, right or bottom bounds.
* And in this case if browser option {@link https://github.com/gemini-testing/hermione#compositeimage compositeImage} set to `false`, then only visible part of the element will be captured.
* But if {@link https://github.com/gemini-testing/hermione#compositeimage compositeImage} set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport.
* And in this case if browser option {@link https://github.com/gemini-testing/testplane#compositeimage compositeImage} set to `false`, then only visible part of the element will be captured.
* But if {@link https://github.com/gemini-testing/testplane#compositeimage compositeImage} set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport.
*
* @defaultValue `false`
*/
Expand Down

0 comments on commit 9eedbdd

Please sign in to comment.