[FEATURE]: add a dry run option for 'buildtest build'

[shahzebsiddiqui]

Please describe your feature

Currently we have buildtest build --stage=build which really doesn't make sense we should make this be buildtest build --dry-run where its sole purpose is to show list of tests that will potentially be run without actually running them.

That being said we should remove option buildtest build --stage=build

Suggest potential solution

No response

Additional Information

• Add cli option --dry-run in argparser
• Add option to bash completion
• Remove option --stage from argparser and remove implementation see

  buildtest/buildtest/cli/build.py

  Line 1013 in c783521

  if not self.builders or self.stage == "parse":

  and

  buildtest/buildtest/cli/build.py

  Line 1025 in c783521

  if self.stage == "build":

• Update json schema https://github.com/buildtesters/buildtest/blob/devel/buildtest/schemas/settings.schema.json for adding property dryrun in the profiles section which will be used to record option into configuration file when buildtest build --dryrun --save-profile is specified
• Update methods

  buildtest/buildtest/cli/build.py

  Line 853 in c783521

  def save_profile_to_configuration(self):

  and and

  buildtest/buildtest/cli/build.py

  Line 928 in c783521

  def load_profile(self):

  to record dryrun as an option that is saved into rerun file and loaded back up when buildtest build --profile is used
• Update docs page https://github.com/buildtesters/buildtest/blob/devel/docs/gettingstarted/buildingtest.rst by removing reference to --stage. Best would be to use search feature in the docs to find all reference to --stage and remove it.
• Add doc section for dry-run same page (https://github.com/buildtesters/buildtest/blob/devel/docs/gettingstarted/buildingtest.rst)
• Add regression test in class TestBuildTest in https://github.com/buildtesters/buildtest/blob/devel/tests/cli/test_build.py
• Please add argument dryrun when calling BuildTest class in

  buildtest/tests/cli/test_build.py

  Lines 502 to 522 in c783521

  	BuildTest(
  	configuration=buildtest_configuration,
  	buildspecs=buildspecs,
  	exclude_buildspecs=buildspecs,
  	tags=["python"],
  	executors=["generic.local.csh"],
  	exclude_tags=["python"],
  	numnodes=[1],
  	numprocs=[2],
  	account="dev",
  	modules="gcc/9.1.0",
  	unload_modules="gcc",
  	modulepurge=True,
  	limit=10,
  	rebuild=2,
  	timeout=60,
  	executor_type="local",
  	remove_stagedir=True,
  	max_jobs=2,
  	buildtest_system=self.system,
  	save_profile="demo",

  to ensure we test all options for buildtest build when using --save-profile

Post question in Slack

• I agree that I posted my question in slack before creating this issue

Is there an existing issue

• I confirm there is no existing issue for this issue