budibase/packages/server/src/utilities/tests/csvParser.spec.js

const { readFileSync } = require("../fileSystem")
const csvParser = require("../csvParser")

const CSV_PATH = __dirname + "/test.csv"

const SCHEMAS = {
  VALID: {
    Age: {
      type: "number",
    },
  },
  INVALID: {
    Address: {
      type: "number",
    },
    Age: {
      type: "number",
    },
  },
  IGNORE: {
    Address: {
      type: "omit",
    },
    Age: {
      type: "omit",
    },
    Name: {
      type: "string",
    },
  },
  BROKEN: {
    Address: {
      type: "datetime",
    },
  },
}

describe("CSV Parser", () => {
  const csvString = readFileSync(CSV_PATH, "utf8")

  describe("parsing", () => {
    it("returns status and types for a valid CSV transformation", async () => {
      expect(await csvParser.parse(csvString, SCHEMAS.VALID)).toEqual({
        Address: {
          success: true,
          type: "string",
        },
        Age: {
          success: true,
          type: "number",
        },
        Name: {
          success: true,
          type: "string",
        },
      })
    })

    it("returns status and types for an invalid CSV transformation", async () => {
      expect(await csvParser.parse(csvString, SCHEMAS.INVALID)).toEqual({
        Address: {
          success: false,
          type: "number",
        },
        Age: {
          success: true,
          type: "number",
        },
        Name: {
          success: true,
          type: "string",
        },
      })
    })
  })

  describe("transformation", () => {
    it("transforms a CSV file into JSON", async () => {
      expect(
        await csvParser.transform({
          schema: SCHEMAS.VALID,
          csvString,
        })
      ).toMatchSnapshot()
    })

    it("transforms a CSV file into JSON ignoring certain fields", async () => {
      expect(
        await csvParser.transform({
          schema: SCHEMAS.IGNORE,
          csvString,
        })
      ).toEqual([
        {
          Name: "Bertå",
        },
        {
          Name: "Ernie",
        },
        {
          Name: "Big Bird",
        },
      ])
    })

    it("throws an error on invalid schema", async () => {
      await expect(
        csvParser.transform({ schema: SCHEMAS.BROKEN, csvString })
      ).rejects.toThrow()
    })
  })
})