How can you run the migration helper to v10 in CLI mode?

[queicherius]

With Cypress 10 and all the changes required to upgrade, you introduced a migration helper in GUI mode.

I can not find any information about how to run this headless/without the UI. Is there one currently / is there one planned? I am always running Cypress on the CLI only, on a server without a display connected, and this would be super helpful. Thanks!

[lmiller1990]

Currently there is no CLI - you need to use the UI. There's a few decisions you need to make, and the UI makes it more clear what's going on.

Generally, I'd recommend opening Cypress 10 at least once locally and completing the migration process via the UI.

[edaldridge]

Using a GUI is not possible on a server that doesn't have one, I use Jenkins to run tests on a headless Linux server. At the moment I am having to run all my tests on 9.7 and maintain two folders in my repo, one for locally using version 10 and the other to allow Jenkins to work.

Would be great if there was a step by step guide to upgrading via the CLI as I can't believe I am the only one in this position

[lmiller1990]

Right, I see.

I think you can do this entire migration only changing one file, which is cypress.json -> cypress.config.js. The main fields that have changed are integrationFolder and testFiles got merged into a single property: specPattern, and pluginsFile is now setupNodeEvents. An example can be found in our tests: before and after. There is a bunch more examples - anything starting with migration-e2e in this directory contains a cypress.json and an expected-cypress.config.js.

Alternatively: If you just want to migrate and move on with more important things, I can just do it for you, since I know all the changes.

Can you share your cypress.json file here? It'll be faster if I just migrate it by hand, I can't promise it'll work perfectly first try, but I can get you 90% of the way there.

[edaldridge]

{ "projectId": "9dwiye", "chromeWebSecurity": false, "defaultCommandTimeout": 50000, "experimentalFetchPolyfill": true, "viewportWidth": 1920, "viewportHeight": 1080, "trashAssetsBeforeRuns": true }

[lmiller1990]

Nice, mostly defaults. Give this a try. We have pretty good error handling; if something isn't quite correct, it should print a useful message. I'm not sure if your project uses TypeScript or any plugins, so I just did the most minimal, basic changes.

Let me know how it goes.

module.exports = {
  projectId: "9dwiye",
  chromeWebSecurity: false,
  defaultCommandTimeout: 50000,
  experimentalFetchPolyfill: true,
  viewportWidth: 1920,
  viewportHeight: 1080,
  trashAssetsBeforeRuns: true,
  e2e: {
    supportFile: "cypress/support/index.js",
    specPattern: "cypress/integration/**/*",
    setupNodeEvents(on, config) {
      return require("./cypress/plugins/index.js")(on, config);
    },
  },
};

[edaldridge]

Thank you for the help Lachlan, I may not get a chance to try this for a while but I wanted to let you know I'd seen it and will post back and let you know how it goes!

[lmiller1990]

No worries, let me know how it goes.

[edaldridge]

Hi Lachlan My apologies for not coming back on this sooner.. I’d been putting it off but the recent update to 12 has forced me to finally start looking at this. I’ve uploaded the cypress.config.js file with the entries you gave me, I am getting an error below : “Your configFile is invalid: /opt/jenkins/workspace/HaywardsHeath/DDMS/aftJapan/QA Server/atfJapanAddCustomer/cypress.config.js It threw an error when required, check the stack trace below: Error: Cannot find module 'cypress'” . Jenkins installs Cypress through a Node integration with the -g flag, I can’t see anything wrong with that because it’s always worked with v9 of Cypress. Was hoping you had a bright idea I could try? Thanks Ed From: Lachlan Miller ***@***.***> Sent: 28 September 2022 00:22 To: cypress-io/cypress ***@***.***> Cc: Ed Aldridge ***@***.***>; Comment ***@***.***> Subject: Re: [cypress-io/cypress] How can you run the migration helper to v10 in CLI mode? (Discussion #22939) CAUTION: This email originated from outside of Xplor. Please exercise caution when clicking links or opening attachments. No worries, let me know how it goes. — Reply to this email directly, view it on GitHub<#22939 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AQAJ6BIOJGOGNO7LA2JBPBTWAN6S5ANCNFSM54XFXNLQ>. You are receiving this because you commented.Message ID: ***@***.***> Xplor Technologies - CONFIDENTIAL

[edaldridge]

Never mind, I managed to resolve the issue. Peace and tranquillity reign again From: Lachlan Miller ***@***.***> Sent: 28 September 2022 00:22 To: cypress-io/cypress ***@***.***> Cc: Ed Aldridge ***@***.***>; Comment ***@***.***> Subject: Re: [cypress-io/cypress] How can you run the migration helper to v10 in CLI mode? (Discussion #22939) CAUTION: This email originated from outside of Xplor. Please exercise caution when clicking links or opening attachments. No worries, let me know how it goes. — Reply to this email directly, view it on GitHub<#22939 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AQAJ6BIOJGOGNO7LA2JBPBTWAN6S5ANCNFSM54XFXNLQ>. You are receiving this because you commented.Message ID: ***@***.***> Xplor Technologies - CONFIDENTIAL

[lmiller1990]

May peace and tranquillity reign again continue forevermore, we will not make any major changes like this for the foreseeable future.