How would you test file upload ?

[JonathanCabezas]

Hello,

How would you test an endpoint using ez.upload() as input ?

I want to do something similar to this Stack Overflow answer:

const fs = require('fs');
const MockExpressRequest = require('mock-express-request');
const FormData = require('form-data');

const form = new FormData();
form.append('my_file',
  fs.createReadStream(path.join(__dirname, 'fixtures', 'file-upload-test.txt'))
);
const request = new MockExpressRequest({
  method: 'POST',
  host: 'localhost',
  url: '/upload',
  headers: form.getHeaders()
});

form.pipe(request);
doUpload(request, response, next);

But I don't want to add dependencies just for this test case.

[RobinTail]

Hello @JonathanCabezas ,

Upload functionality relies on express-fileupload body parser which is not covered by the unit testing helper testEndpoint().
You can use testEndpoint with { requestProps: { method: "POST", body: data }} where data is already a parsed object, but that would be the test of the endpoint handler, not the parser, like the upload did already happen.

For testing the upload functionality you'd need a system test:

1. Spawn a process running your application:

   express-zod-api/tests/system/example.spec.ts

   Line 19 in 6e23748

   const example = spawn("tsx", ["example/index.ts"]);

2. Ensure it's listening (ready to accept requests):

   express-zod-api/tests/system/example.spec.ts

   Line 22 in 6e23748

   await vi.waitFor(() => assert(out.includes(`Listening`)), { timeout: 1e4 });

3. Use FormData and fetch to perform an actual request like this:

   express-zod-api/tests/system/example.spec.ts

   Lines 195 to 213 in 6e23748

   	test("Should upload the file", async () => {
   	const filename = "logo.svg";
   	const logo = await readFile(filename, "utf-8");
   	const data = new FormData();
   	data.append(
   	"avatar",
   	new Blob([logo], { type: "image/svg+xml" }),
   	filename,
   	);
   	data.append("str", "test string value");
   	data.append("num", 123);
   	data.append("arr[0]", 456);
   	data.append("arr[1]", 789);
   	data.append("obj[some]", "thing");
   	const response = await fetch(
   	`http://localhost:${port}/v1/avatar/upload`,
   	{ method: "POST", body: data },
   	);
   	const json = await response.json();

[JonathanCabezas]

I was able to implement such a test.
Thank you for the quick answer !