582 602 expected docker compose err

[devinsag]

Overview

Please see:

https://gitlab.com/architect-io/architect-cli/-/issues/582

https://gitlab.com/architect-io/architect-cli/-/issues/602

Changes

Add a check to see if yaml is empty before parsing.

• Throws error if empty.

Add try catch around dev buildImage function.

• Catch identified error message and display message to screen.

Tests

run dev command against empty architect.yml file. See error message, and no sentry submission
run dev command with a dockerfile containing an exception. See error message, and no sentry submission.

test
    .timeout(20000)
    .stub(ComponentBuilder, 'loadFile', () => {
      return '';
    })
    .stub(Dev.prototype, 'failIfEnvironmentExists', sinon.stub().returns(undefined))
    .stub(Dev.prototype, 'runCompose', sinon.stub().returns(undefined))
    .stub(Dev.prototype, 'downloadSSLCerts', sinon.stub().returns(undefined))
    .stub(Dev.prototype, 'readSSLCert', sinon.stub().returns('fake-cert'))
    .stdout({ print })
    .stderr({ print })
    .command(['dev', './examples/hello-world/architect.yml'])
    .catch(err => {
      expect(err.message).to.include('For help getting started take a look at our documentation here: https://docs.architect.io/reference/architect-yml');
    })
    .it('Provide error if architect.yml is empty');

Pictures

Docker compose error

Empty architect.yml

[TylerAldrich]

This pattern isn't sufficient, if I run architect dev -e foo the failure is

Command failed with exit code 17: docker compose -f /Users/tyler/.config/architect/local/architect/architect/docker-compose/foo.yml -p foo build

the -p argument is equivalent to the environment we pass in.

We should be able to get the exit code from e.exitCode and check that value instead. Is exit code 17 the only possibility / the only exit code we care about? I imagine any non-zero exit code from docker compose build wouldn't be something we can fix on our end, but not 100% sure of that

[devinsag]

Updated logic to fetch docker compose exit code e.exitCode instead of parsing error message. Updated to throw error when non-zero exit code.

[TylerAldrich]

I'm pretty sure this information is in the exception object returned by execa - I believe e.stderris available so we don't need to set the string this way. You can run console.log(e) to quickly see the various keys available - but I think that would be the same information that's being captured here

[devinsag]

removed on-data function

[github-actions]

🎉 This PR is included in version 1.32.0 🎉

The release is available on:

• v1.32.0
• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀