Common Test SUITE template #2070
Conversation
| {name, "suite", "Name of the suite, prepended to the standard _SUITE suffix"} | ||
| ]}. | ||
| {dir, "test"}. | ||
| {template, "ct_suite.erl", "test/{{name}}_SUITE.erl"}. |
There was a problem hiding this comment.
This is one of the problems we have overall with the templater. It only works from the current working directory, and we get a bit of a funny thing for umbrella releases where the tests might go in appname/test/{{name}}_SUITE.erl.
Can you quickly check if we can allow {{dir}}/{{name}}_SUITE.erl as a path but with dir configurable with a default to test?
There was a problem hiding this comment.
I was also going to add a feature for getting the name of the parent directory to use. I need that to complete the init-release template so it has a good default name. Could use the same for this.
priv/templates/ct_suite.erl
Outdated
| init_per_suite/1, end_per_suite/1, | ||
| init_per_group/2, end_per_group/2, | ||
| init_per_testcase/2, end_per_testcase/2 | ||
| ]). |
There was a problem hiding this comment.
Any opinions on using -compile(export_all). just for the CT suite as Tristan initially suggested in the issue? I know that out of laziness I often revert to that one just for CT suites as well.
There was a problem hiding this comment.
I'd vote against export_all. Not only it requires to suppress compiler warning, but also creates "accidental interface" that works in test mode only.
So far I've been happy with just evaluating the code (e.g. using power_shell, https://github.com/WhatsApp/power_shell)
There was a problem hiding this comment.
It is a test module, it only runs in test mode :). And doesn't really have an interface because it isn't called by anything but the ct runner.
There was a problem hiding this comment.
That one is a test module, but text message suggests to suppress "export_all warning" for the entire project compiled with test profile.
I agree, export_all for test SUITE makes sense, I just wish it's possible to enable warning suppression it only for test/ folder of the project.
There was a problem hiding this comment.
Wouldn't -compile([export_all, nowarn_export_all]). prevent warnings only in this module? It seems to work well on a small shell test here, but I haven't checked across all versions.
There was a problem hiding this comment.
@max-au true, but a regular compile would still have the warning and building like a release would then still warn or error so it couldn't go to prod.
But point taken and looks like Fred has a solution.
|
I finished one yesterday too and forgot to open it. it adds additional functionality to |
|
Personally not a fan of so many comments in a template. But I'm fine with being out voted on it and then we can just merge our PRs #2072 :) |
Comments are great if it is the first time you see a template, but when it is the 100th they are just in the way. So IMO it depends on whether you want to help first time users or experienced developers more. |
|
@garazdawi my thoughts exactly. I figure the first time the user can use http://erlang.org/doc/apps/common_test/example_chapter.html We could put a link to that in the template at the top. Or in the new usage output that is added in my PR. |
|
Agree, comments should be removed, let me update it. Not sure about export_all though, and compiler warning suppression. |
|
I'm more open to the comments than I am to a full list of functions :). |
Contains boilerplate code and a few hints how Common Tests are to be used
max-au
force-pushed
the
common_test_suite_template
branch
from
f75dbc1
to
b81aa63
Compare
|
@ferd @max-au I had a thought. What if we added the CT suite with all the comments as a part of the It looks like this one was updated to be simpler already so would be the one used in the latter? |
|
Yeah that sounds good to me. Showing to people where to put their tests in the initial template sounds good, and we can afford more docs into that one. |
|
I like this suggestion too. |
|
@max-au can you revert to the original template you had and add it to the I'd prefer it included: -compile(nowarn_export_all).
-compile(export_all).But I suppose it doesn't have to. |
Contains boilerplate code and a few hints how Common Tests are
to be used