README.md

Cypress Protobuf example

I was asked to provide an example of a Cypress test using Protobuf.

example.js

// cypress/plugins/index.js
module.exports = on => {
  on("task", {
    protobufEncode: require("cypress-protobuf"),
  });
};


// custom Cypress command code
export function customRoute() {
  return cy.fixture("fixture.json").then(json => {
    cy.task("protobufEncode", {
      fixtureBody: json,
      message: "Status"
    }).then(result => {
      cy.route({
        headers: {
          // set content-type headers
          "content-type": "application/octet-stream"
        },
        method: "GET",
        response: result,
        status: 200,
        url: `**api/status`
      }).as("customRoute");
    });
  });
}

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


// test's code
before(() => {
  cy.task("protobufEncode", {
    protoFilePath: "./public/ui.proto"
  });
});

describe("Bar", () => {
  it("Foo", () => {
    cy.customRoute();
    cy.wait("@customRoute");  
  });
});