ioc.fake in AdonisV5

[vowar]

Is it possible to do something like this in adonisV5 to fake services for tests?

ioc.fake('Twilio', () => {
      return {
        sendSMS: async () => { ... },
        sendVerificationCode: async () => { ... },
        checkVerificationCode: async () => { ... }
      }
    })

[thetutlage]

If you can share the exact test code, then I can try to help on how to achieve this. The current example is too abstract

[4konung]

Hi! I have maybe the same question.
I have a controller that uses Twilio service like this:

import twilio from '@ioc:Services/Twilio'

export default class SomeController {

public async sendSms({ auth }: HttpContextContract) {
    const user = auth.user
    await twilio.sendSms(user.phone, 'message: Some text')

    return response.apiSuccess()
  }
}

and I want to 'fake' this service method when tests are running.

[thetutlage]

Ohhh. Should have share a complete example

import Application from '@ioc:Adonis/Core/Application'

Application.container.fake('Services/Twilio', () => {
  
})

[eidellev]

Hi @thetutlage,
I'm new to adonis and enjoying it so far. Thanks for your hard work :-)

.fake doesn't seem to do anything, but if I replace it with singleton it overrides the original.
This is my test:

import test from 'japa';
import Application from '@ioc:Adonis/Core/Application';
import supertest from 'supertest';

test.group('Git Controller', () => {
  test('Check out default branch', async (assert) => {
    Application.container.fake('Services/Git', () => {
      return {
        checkout() {
          doTheThing();
        },
      };
    });

    const response = await supertest(BASE_URL)
      .post('/git/login')
      .send({
        url: 'https://www.sapiens.com/',
        username: 'cdcdcd',
        password: 'cdcdcd',
      })
      .expect(200);

    assert.equal(true, true);

    Application.container.restore('/Services/Git');
  });
});

[thetutlage]

How are you using the Services/Git in your controller? Can you share that too?

[4konung]

I've tried what you recommended but nothing changed. The real Twilio service calls his 'sendSMS' method during the tests.
Maybe I misunderstood how to use Providers?
Here is example how I use.

[eidellev]

Thanks @thetutlage ,

This is how I'm registering my service:

// providers/AppProvider.ts
import { IocContract } from '@adonisjs/fold';
import GitService from 'App/Services/GitService';

export default class AppProvider {
  constructor(protected $container: IocContract) {}

  public async register() {
    // Register your own bindings
    const Logger = (await import('@ioc:Adonis/Core/Logger')).default;
    this.$container.singleton('Services/Git', () => new GitService(Logger));
  }

  public boot() {
    // IoC container is ready
  }

  public shutdown() {
    // Cleanup, since app is going down
  }

  public ready() {
    // App is ready
  }
}

And this is my controller:

// app/Controllers/Http/GitController.ts
import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
import { schema, rules } from '@ioc:Adonis/Core/Validator';
import GitService from '@ioc:Services/Git';

const gitCredentialsSchema = {
  url: schema.string({}, [rules.httpsUrl()]),
  username: schema.string(),
  password: schema.string(),
};

export default class GitController {
  public async checkout({ request, params }: HttpContextContract) {
    const { branch }: { branch: string | undefined } = params;

    const { url, username, password } = await request.validate({
      schema: schema.create(gitCredentialsSchema),
    });

    return GitService.checkout(url, username, password, branch);
  }

  public async createBranch({ request }: HttpContextContract) {
    const { url, username, password, fromBranch, branch } = await request.validate({
      schema: schema.create({
        ...gitCredentialsSchema,
        fromBranch: schema.string(),
        branch: schema.string(),
      }),
    });

    return GitService.createBranch(url, username, password, fromBranch, branch);
  }

  public async getFile({ request }: HttpContextContract) {
    const { url, username, password, branch, file } = await request.validate({
      schema: schema.create({
        ...gitCredentialsSchema,
        branch: schema.string(),
        file: schema.string(),
      }),
    });

    return GitService.getFile(url, username, password, branch, file);
  }

  public async writeFile({ request }: HttpContextContract) {
    const { url, username, password, branch, file } = await request.validate({
      schema: schema.create({
        ...gitCredentialsSchema,
        branch: schema.string(),
        file: schema.string(),
        data: schema.object().members({
          name: schema.string(),
          steps: schema.array().members(
            schema.object().members({
              stepType: schema.string(),
            }),
          ),
        }),
      }),
    });

    return GitService.writeFile(url, username, password, branch, file, request.post().data);
  }
}

[vowar]

@thetutlage Also the description for the fake method says:

Register a fake for an existing binding. The fakes only work when [[this.useProxies]] is invoked. AdonisJs will set invoke it automatically when running tests.

Can it be an issue with the proxies? Or there should be some additional steps? While tests are running I've console logged the container and the proxiesEnabled property is false

[eidellev]

thanks @vowar ! adding Application.container.useProxies(); fixed my issue.

[4konung]

where I need to add this call? japaFile or in spec file?

[eidellev]

at the top of my test suite:

test.group('Git Controller', () => {
  Application.container.useProxies();
...

[4konung]

@thetutlage The proposed answer with adding Application.container.useProxies() didn't helps for all my cases. Today I found some interesting behavior. Faking works If service used in the controller method, but in inline closure, fake doesn't work. In my project, some services used even in models, and I need somehow to fake them during the tests. Any suggestions?

[thetutlage]

@4konung Its hard to answer without looking at the application lifecycle. Ideally Application.container.useProxies should be called as early as possible. Otherwise the services resolved before the useProxies calls will point to the original source and not the proxied object.

If your app is straight forward to setup and follow, then feel free to add me to the project and I can suggest something

[4konung]

repo with an example. A new issue appeared while I prepared this repo. Now when Application.container.useProxies called in test file, I've got this error - TypeError: User_1.default.create is not a function, but this doesn't happen in the project.