You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by da...@apache.org on 2023/06/17 07:17:11 UTC

[causeway] 02/06: CAUSEWAY-3395: removes TODO, adds intro docs for the command replay module

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/causeway.git

commit 82ad5cecbe3c34f9c16a9f161455db4ed2bb93c6
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sat Jun 17 07:49:44 2023 +0100

    CAUSEWAY-3395: removes TODO, adds intro docs for the command replay module
---
 .../core/commandreplay/adoc/modules/commandreplay/pages/about.adoc | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/incubator/extensions/core/commandreplay/adoc/modules/commandreplay/pages/about.adoc b/incubator/extensions/core/commandreplay/adoc/modules/commandreplay/pages/about.adoc
index 4726fb8df7..34a09a9532 100644
--- a/incubator/extensions/core/commandreplay/adoc/modules/commandreplay/pages/about.adoc
+++ b/incubator/extensions/core/commandreplay/adoc/modules/commandreplay/pages/about.adoc
@@ -3,5 +3,10 @@
 
 :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
 
-WARNING: TODO: v2 - to document
+The intention of the `CommandReplay` module is to allow commands -- representing either action invocations or property edits -- to be taken from a primary system and replayed against a secondary system.
+
+It does this by exposing a REST API on the primary system to return (representations of) xref:refguide:extensions:index/commandlog/applib/dom/CommandLogEntry.adoc[CommandLogEntry]s, called at regular intervals by the secondary system.
+These are copied into the secondary system and then executed.
+
+The main use case is for regression testing.