赛普拉斯没有看到自定义 cy。命令

Question

赛普拉斯无法导入自定义命令

commands.js

Cypress.Commands.add('generateToken', ({secret}) => {
    const totp = require('totp-generator');
    const token = totp(secret); 
    });

支持/index.js

import './commands'

test.spec.ts

/// <reference types="Cypress" />

context('Actions', () => {
    beforeEach(() => {})
  })
    it('Main test', () => {
        cy.generateToken('XXXX');
    })

test.spec.ts 中的 generateToken() 始终加下划线并出现错误：

Property 'generateToken' does not exist on type 'cy'.

index.js 和 commands.js 没有从原始目录中移动。 cypress.json 文件为空。

Answer 1

由于您的规范是一个打字稿文件，您是否为 support/index.js 添加了新的类型定义？

他们的文档似乎很好地概述了它here。不过，与他们的示例不同的是，您没有从 generateToken 返回任何内容，因此我认为您不能将其放入全局 Chainable 接口中。

您可以尝试将其添加到 support/index.d.ts 文件中，看看它是否对您大喊大叫

declare namespace Cypress {
  interface Chainable {
    generateToken({secret}: {secret: string}): void
  }
}

Answer 2

这是我如何让 TypeScript 查看我的自定义命令：

commands.ts

declare namespace Cypress {
  interface Chainable<Subject> {
    generateToken(secret: any): Cypres.Chainable<void>;
  }
}

function generateToken(secret: any): void {
  // Generate token
}

Cypress.Commands.add('generateToken', generateToken);

test.spec.ts

cy.generateToken(secret);

Answer 3

2021 年全面开工。

对于support/index.ts 文件

import './commands'

对于support/commands.ts 文件

Cypress.Commands.add('generateToken', generateToken);
function generateToken({secret}): void {
    const totp = require('totp-generator');
    const token = totp(secret); 
}

// this is another example.
Cypress.Commands.add('login', login);
function login(username: string, password: string): void {
    // steps for login 
}

declare namespace Cypress {
    interface Chainable<Subject> {
       generateToken({secret}): void;

       /**
        * This will log user in
        * @param email string
        * @param password string
        */
       login(email: string, password: string): void;
    }
}

对于test.spec.ts 文件

cy.login("somebody@domain.com", "something");
cy.generateToken("Example");

其他答案都不适合我。我想在 VS Code 中提供类型支持，并且不想面对 cypress Property does not exist on type 'cy & EventEmitter' 运行时错误。

我添加了另一个支持 JSDoc 的登录示例。

Answer 4

由于 nshirley 提出的答案对我不起作用，我找到了this 评论。 它非常相似，但在顶部添加了declare global，以在全局范围内声明这些自定义命令。

这是一个工作示例：

cypress/support/commands.ts：

declare global {
  namespace Cypress {
    interface Chainable<Subject> {
      /**
       * Provides a working example
       */
      generateToken(secret: any): Cypress.Chainable<Element>;
    }
  }
}

const generateToken = (secret: any) => {
  // Your Code
};

Cypress.Commands.add("generateToken", generateToken);

在你的测试中你可以直接使用它：

cy.generateToken("Example");

如您所见，您甚至可以为您的方法提供一些文档，但这完全是可选的。

Answer 5

尝试致电Cypress.generateToken('XXXX'); 可以吗？

另外，在添加命令时尝试删除不必要的括号。试试这个：

Cypress.Commands.add('generateToken', secret => {
    const totp = require('totp-generator');
    const token = totp(secret); 
});

Answer 6

试试下面看看是否有效。

Cypress.Commands.add('generateToken', { prevSubject: false }, ({secret}) => {

// 你的代码。

});

Answer 7

在 support/command.js 中做这样的事情

Cypress.Commands.add('generateToken', (secret) => {

       const totp = require('totp-generator');
       const token = totp(secret);
  };
  cy.request(options)

});

然后在你的js代码中

    /// <reference types="Cypress" />

context('Actions', () => {
    beforeEach(() => {})
  })
    it('Main test', () => {
        const token ='XXXX'
        cy.generateToken(token);
    })

编辑 1

你可以添加这个，并且可以根据你的测试添加更多的迭代等待

describe('check the tokens', function() 
{
// on 30 seconds 
it('first token ',()=> {
    cy.wait(30000).then(()=>{
        const token = getToken();   // You're waiting here for 30 sec before you get token
        console.log('first token: ' + token);
    })
})
// on 60 seconds 
it('second token', ()=>{
    cy.wait(60000).then(()=>{
        const token = getToken();
        console.log('second token: '+ token);
    });
})
})

function getToken () {
    const totp = require('totp-generator');
    const token = totp('ABCD');
    return token;
  }

Answer 8

在tsconfig.json中添加路径

{
  "include": [
    "integration/*.ts",
    "support/*.ts"
  ]
}