Skip to content

Commit 6d0bdf8

Browse files
Purge old rose stem commands and options (#437)
1 parent 4645d56 commit 6d0bdf8

4 files changed

Lines changed: 13 additions & 65 deletions

File tree

components/lfric-xios/Makefile

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -107,25 +107,6 @@ integration-tests/%: export TEST_DIR = integration-test
107107
integration-tests/%: export WORKING_DIR := $(WORKING_DIR)/integration-tests
108108
integration-tests: integration-tests/run
109109

110-
##############################################################################
111-
# Test suite rules
112-
#
113-
.PHONY: launch-suite-gscan
114-
launch-suite-gscan: gscan_processes := $(shell ps --no-headers -o command -C cylc-gscan)
115-
launch-suite-gscan: ALWAYS
116-
$(Q)-if [[ "$(gscan_processes)" != *"--name=$(SUITE_GROUP_NAME)"* ]]; then \
117-
cylc gscan $(DOUBLE_VERBOSE_ARG) --name=$(SUITE_GROUP_NAME) & \
118-
usleep 1 ;\
119-
fi
120-
121-
.PHONY: test-suite
122-
test-suite: SUITE_BASE_NAME = $(notdir $(realpath $(shell pwd)/$(CORE_ROOT_DIR)))-$(PROJECT_NAME)
123-
test-suite: SUITE_CONFIG = rose-stem
124-
test-suite: launch-suite-gscan launch-test-suite
125-
$(Q)echo > /dev/null
126-
127-
print-% : ; @echo $* = $($*)
128-
129110
##############################################################################
130111
# Clean
131112
#

documentation/source/getting_started/installation/build_and_run.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,17 @@ time you will want to commit changes to the upstream repository. A
8989
``.gitignore`` file, found at the top-level of the directory tree, should
9090
prevent you inadvertently including build artefacts in your commit if you ever
9191
run a ``git add .`` command. But do use ``git status`` to be sure of what your
92-
changeset includes. Note that it is always safer to use ``git add <filename>`` on the specific files you want to add/change.
92+
changeset includes. Note that it is always safer to use ``git add <filename>``
93+
on the specific files you want to add/change.
9394

9495
Running ``make clean`` will remove the working, test and bin directories.
9596

9697
After building an application from the command line, it can be useful to do a
9798
quick test to ensure it can run. Most applications in the lfric and lfric_apps
9899
repository hold a simple example configuration in their ``example`` directory
99-
(which is also included in the ``.gitignore`` file, so if you want to add or change files in the ``example`` directory, you will need to use ``git add -f ...``).
100+
(which is also included in the ``.gitignore`` file, so if you want to add or
101+
change files in the ``example`` directory, you will need to use ``git add -f
102+
...``).
100103

101104
After building, go into to the example directory and run the application, as
102105
follows:
@@ -115,15 +118,16 @@ Running the Cylc test suite
115118

116119
To run the test suites, Cylc and Rose need to be installed.
117120

118-
The ``rose stem`` command selects the group of tests to run. Then ``cylc play``
119-
starts the suite running. For example, to run the developer tests for all the
120-
applications and components within an LFRic working copy, run the following from
121-
the top-level of the working copy:
121+
The tests are defined in the ``rose-stem`` directory within the the top-level of
122+
the clone of the repository. To run the developer tests for all the
123+
applications, ``cd`` to the top-level directory and run the following:
122124

123125
.. code-block::
124126
125-
rose stem --group=developer
126-
cylc play <working_copy_name>
127+
cylc vip -z group=developer -n NAME ./rose-stem
128+
129+
The ``NAME`` argument defines the name of the suite, which will be the name of
130+
the top-level directory created or used within the ``~/cylc-run`` directory.
127131

128132
Building the documentation
129133
--------------------------

documentation/source/how_to_use_it/build_and_test/use_of_make.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ directory), build and run any unit tests, and build and run any
1616
integration tests. The Makefile supports options to execute any of
1717
these choices individually.
1818

19-
The Makefile can be used to run the Rose Stem system test
20-
suite: run ``make test-suite``.
21-
2219
Each Makefile takes other optional arguments, for example to
2320
obtain verbose output or to choose different sets of compile
2421
options. Each application or component will describe the options

infrastructure/build/lfric.mk

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,9 @@
2424
# files" performance, i.e. probably not Lustre.
2525
# Default: ./working
2626
# VERBOSE: Set in order to see actual commands issued by the build system.
27-
# PURGE_SUITES: Set to non-zero value to clean out exisiting rose suites of
28-
# same name. (this is also the default action)
29-
# Set to zero to not clean out existing rose suite.
3027
# TEST_SUITE_TARGETS: Space separated list of target identifiers to be used
3128
# when launching the test suite. Default is "meto-azspice
3229
# meto-ex1a"
33-
# SUITE_GROUP_ABRV: Set to a non-zero value to cause the names of the rose
34-
# stem groups to always be abbreviated in the suite name.
35-
# Set to zero to cause the names to always be unabbreviated.
36-
# The default is abbreviated for multi-group runs, but
37-
# unabbreviated for single-group runs.
38-
#
3930
##############################################################################
4031

4132
.SECONDEXPANSION:
@@ -158,13 +149,6 @@ endif
158149

159150
export Q QUIET_ARG VERBOSE_REDIRECT
160151

161-
# Set flag to perform a fresh rose stem suite
162-
163-
CLEAN_OPT ?= '--new'
164-
ifeq '$(PURGE_SUITES)' '0'
165-
CLEAN_OPT =
166-
endif
167-
168152
# We only want to send terminal control characters if there is a terminal to
169153
# interpret them...
170154
#
@@ -202,13 +186,7 @@ define ANNOUNCE_BODY
202186
*******************************************************************************
203187
Error
204188

205-
The Cylc 7 test suite is no longer in use, please use the Cylc 8 suite.
206-
207-
New commands:
208-
209-
export CYLC_VERSION=8
210-
rose stem --group=developer
211-
cylc play <working_copy_name>
189+
The Cylc 7 test suite is no longer in use.
212190

213191
*******************************************************************************
214192

@@ -263,18 +241,6 @@ api-documentation: ALWAYS
263241
echo OUTPUT_DIRECTORY=$(DOCUMENT_DIR) ) \
264242
| doxygen - $(VERBOSE_REDIRECT)
265243

266-
##############################################################################
267-
# Launch test suite
268-
#
269-
# SUITE_CONFIG - Path to rose-stem directory.
270-
# SUITE_BASE_NAME - Name for suites.
271-
# SUITE_GROUP_NAME_ABRV - Name(s) of the rose stem group(s) with abbreviations applied.
272-
#
273-
.PHONY: launch-test-suite
274-
launch-test-suite:
275-
$(error $(ANNOUNCE_BODY) )
276-
277-
278244
##############################################################################
279245
# Generate configuration source.
280246
#

0 commit comments

Comments
 (0)