Invalid config file shows as valid about circleci-cli HOT 5 CLOSED

@felicianotech I think because we aren't performing config schema checks.

The build-agent CLI has the original schema and when you run config validate it will check it against that schema producing these errors:

Error: 1 error occurred:

* Config file is invalid:
  at jobs: docker:jj: Additional property docker:jj is not allowed

However, unless I bump the config version to 2.1, I just get back the same config as "valid", as you saw.

from circleci-cli.

This seems to be valid YAML:

marc@blaster ~/tmp $ pbpaste > felicianotech.yml
marc@blaster ~/tmp $ irb
irb(main):001:0> require 'yaml'
=> true
irb(main):002:0> pp YAML.load(File.read('foo.yml'))
{"version"=>2,
 "jobs"=>
  {"build"=>
    {"docker"=>[{"image"=>"cibuilds/hugo:0.46"}],
     "docker:jj"=>nil,
     "steps"=>
      ["checkout",
       {"run"=>
         {"name"=>"Build Website With  Hugo", "command"=>"echo \"Hi\""}}]}}}

from circleci-cli.

This is valid yaml and valid schema.

Yaml doesn't dictate minimum or maximum amount of whitespace for separating different levels, so 1-space indentation is the same as 2 or 3 space indentation. You can mix tabs and spaces as well, for better or for worse.

We allow for unexpected keys. We have to balance two things with unexpected keys

• a key like docker:jj: is most likely a typo when I glance at this config
• We've allowed and encouraged use of yaml anchors. If we disallow for arbitrary keys under build:, that could break currently valid builds where they use a meaningless* section like docker_shared: at the same level as docker.

• meaningless as in that section carries no meaning to our execution environment

from circleci-cli.

This also passes for having a docker: key with no image specified.

I understand what you're saying, but these would be clear mistakes that will fail when we try to run the config. The whole point of the validator is to prevent having to take a config all the way to execution to find a mistake.

How I see it, if a CircleCI config, when run by the executor, fails with an error. It should fail in the validator. Specifically being syntax and scheme.

I don't think the validator should go as far as verifying Docker images exists for example.

from circleci-cli.

That's a good point and I agree: the schema should check for all decidable errors given compilation-time information. I've added this to the teams backlog.

from circleci-cli.