Add more helpful error message for misconfiguration in profiles.yml

[kning]

resolves #2569

Description

Adds an additional catch for if the supplied target returns no data and returns a more helpful error message.

Checklist

• I have signed the CLA
• I have run this code in development and it appears to resolve the stated issue
• This PR includes tests, or tests are not required/relevant for this PR
• I have updated the CHANGELOG.md and added information about my change to the "dbt next" section. <-- not sure if this change warrants a mention quite yet but let me know if you'd like me to add.

Further Validation

Additional screenshot of what the new terminal output looks like (tested against the example target referenced in the issue):

[beckjake]

Thanks for your contribution @kning!

I have a minor copy suggestion I'd like to get feedback on from Jeremy, and a suggestion on catching more bad profiles.

Can you also add an integration test? I think the appropriate place is in test/integration/049_debug_test/test_debug.py.

You can update the postgres profile to add a new entry with "none_target": None instead of an actual target definition, and then add a new test that runs debug --target none_target and make sure it says something reasonable.

Finally, please make a CHANGELOG.md update following the existing pattern, so we can give you credit in our next release! Add yourself to the contributors list for the upcoming release, and add a summary under Features to this PR and the issue. The name of this PR should be a fine summary.

[beckjake]

Suggested change

	msg = (f"{target_name} is misconfigured in your profiles.yml")
	msg = (
	f"output '{target_name}' of profile '{profile_name}' is "
	f"misconfigured in profiles.yml"
	)

It'd be nice to point it at where the issue is a bit more clearly in large profiles, here's one way we could add the profile name in and show that we're talking about outputs: values.

@jtcohen6, do you have any other suggestions on the copy?

[beckjake]

It'd be good to check if not isinstance(profile_data, dict) instead - if it's anything but a dict, we know it's misconfigured.

[kning]

thanks taking a look

[kning]

A question on the integration test @beckjake.

dbt debug actually outputs fine as long as there is one correctly configured target. Thus, adding a new target definition to the existing postgres profile doesn't actually trigger the test case.

I think I'd need to create a separate postgres profile with only an empty target. However, I'm not sure the best way to do this. The way the test is set up it looks like you can only have one postgres profile?

[beckjake]

dbt debug actually outputs fine as long as there is one correctly configured target. Thus, adding a new target definition to the existing postgres profile doesn't actually trigger the test case.

Really? I think it'd be sufficient to specify the bad target on the command line with --target. For example, in test_postgres_wronguser, we run self.run_dbt(['debug', '--target', 'wronguser']). You could do something similar with an empty target, right?

[kning]

ready for review now @beckjake

[beckjake]

This looks good to me! Thanks for your contribution to dbt, and thanks for the test!

I'll merge this once the test passes. Windows tests might fail because of a config issue, that's fine - this is not OS-specific behavior, and I have a fix for that in a different open PR.

[beckjake]

Suggested change

	- Add more helpful error message for misconfiguration in profiles.yml ([#2627](https:/fishtown-analytics/dbt/issues/2569))
	- Add more helpful error message for misconfiguration in profiles.yml ([#2569](https:/fishtown-analytics/dbt/issues/2569), [#2627](https:/fishtown-analytics/dbt/pull/2627))

[beckjake]

Suggested change

	- [@kning](https:/kning) ([#2627](https:/fishtown-analytics/dbt/issues/2569))
	- [@kning](https:/kning) ([#2627](https:/fishtown-analytics/dbt/pull/2627))

[beckjake]

All looks great, this will release in 0.18.0 🎉

[kning]

thanks @beckjake !