fix: support ssh format download template url

[yugasun]

What did you implement

Support ssh format template url, like [email protected]/sample-service.git, actually, many company has their private gitlab, so I think supporting these format template urls is a must.

How can we verify it

I have add unit test for it:

it('should download the service based on a regular .git URL start with git@', () => {
  const url = '[email protected]/sample-service.git';

  return expect(downloadTemplateFromRepo(url)).to.be.fulfilled.then(() => {
    expect(spawnStub.calledOnce).to.equal(true);
    expect(downloadStub.calledOnce).to.equal(false);
    expect(spawnStub.args[0][0]).to.equal('git');
    expect(spawnStub.args[0][1][0]).to.equal('clone');
    expect(spawnStub.args[0][1][1]).to.equal(url);
  });
});

it('should download and rename the service based on a regular .git URL start with git@', () => {
  const url = '[email protected]/sample-service.git';
  const name = 'new-service-name';

  spawnStub.resolves({
    then: callback => {
      const slsYml = path.join(process.cwd(), 'new-service-name', 'serverless.yml');
      writeFileSync(slsYml, 'service: sample-service');
      callback();
    },
  });

  return expect(downloadTemplateFromRepo(url, name)).to.be.fulfilled.then(serviceName => {
    expect(spawnStub.calledOnce).to.equal(true);
    expect(downloadStub.calledOnce).to.equal(false);
    expect(spawnStub.args[0][0]).to.equal('git');
    expect(spawnStub.args[0][1][0]).to.equal('clone');
    expect(spawnStub.args[0][1][1]).to.equal(url);
    const yml = readFileSync(path.join(newServicePath, 'serverless.yml'));
    expect(yml.service).to.equal(name);
    expect(serviceName).to.equal('sample-service');
  });
});

Todos

Useful Scripts

• npm run test:ci --> Run all validation checks on proposed changes
• npm run lint:updated --> Lint all the updated files
• npm run lint:fix --> Automatically fix lint problems (if possible)
• npm run prettier-check:updated --> Check if updated files adhere to Prettier config
• npm run prettify:updated --> Prettify all the updated files

• Write and run all tests
• Write documentation
• Enable "Allow edits from maintainers" for this PR
• Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

[hkbarton]

@medikoo could you review this?

[medikoo]

@yugasun thanks for this update. Still I'm worried it won't work in most of the cases (it crashes for me locally)

Can you clarify why do we need that?

[medikoo]

This url is then provided to download module.

Is it confirmed that it supports urls starting with git@ ?

I've just tried it locally, and it crashed for me with:

Error: Basic authentication must be done with the `auth` option` error

[yugasun]

@medikoo If you want to use this method, you should add your SSH key to your private gitlab setting. Only these who can use git clone command for these private repos. So you can use serverless create --template-url=git@xxx.

[medikoo]

I wonder is it good idea then to allow such urls. It requires an extra effort from user, which may not be obvious upfront, and error message is not meaningful.

Do https://.. urls not work with gitlab? Why do you feel it's important to support git@.. ?

[yugasun]

For my part, I have many private repos only can cloned by git@xxx format url, and I want to using this private project for serverless template. And if somebody want to use git@xxx url, they should know that they have ssh access right.

[medikoo]

@yugasun did you confirmed that this change works for you locally?

On my side it doesn't work (it crashes with Basic authentication must be done...), even though I can without issues clone repos via such url

[yugasun]

@medikoo Of course, this is a demo output:

# yugasun @ YUGASUN-MB0 in ~/Desktop/Playground [14:54:57] 
$ serverless create [email protected]:yugasun/fullstack-application-vue-demo.git
Serverless: Generating boilerplate...
Serverless: Downloading and installing "fullstack-application-vue-demo"...
Serverless: Successfully installed "fullstack-application-vue-demo" 

Before, you use this format url, you should ensure that you can git clone it.

[medikoo]

Indeed I confirm it also works on my side

[medikoo]

Thank you @yugasun !