Removed discourse-gatekeeper/discourse-ahead-ok (#235)

* feat(ISD-1567): removed obsolete code and corresponding documentation

* feat(ISD-1498): removed check in test_check for the removed tag

* feat(ISD-1498): updated test parameters to account for removal of discourse ahead tag removal

* feat(ISD-1498): removed tagged argument from tests

* feat(ISD-1498): ensured all parameters return only 2 values in tuple

* feat(ISD-1498): removed ahead tag from constants file, removed mention in integration tests

* feat(ISD-1498): removed ahead tag from check.py

* feat(ISD-1498): rectified erroneous deletion of expected problem in test check

* feat(ISD-1498): adhered to linting requirements by removing unused src.constants imports

* feat(ISD-1498): fixed all linting issues and fixed method signatures.

* feat(ISD-1498): removed test case 7 from test conflicts

* feat(ISD-1498): removed test 7

* feat(ISD-1498): fixed linting issues

* feat(ISD-1498): updated change log with new version details

* feat(ISD-1498): added src-docs

* feat(ISD-1498): fixed comments in run_conflict integration test

* feat(ISD-1498): removed assert associated with removed act

Author: codethulu

CHANGELOG.md

@@ -5,6 +5,14 @@
 - Added a formatted representation of the UpdatePageAction dataclass for more
   human-readable output.
 
+## [v0.8.2] - 2024-02-16
+
+### Fixed
+
+- Removed soft-conflict ignore button. `discourse-ahead-ok` tag, which was used
+  to indicate changes between discourse and git should no longer be used. Has been
+  removed, with tests updated to reflect this.
+
 ## [v0.8.1] - 2024-01-18
 
 ### Fixed

README.md

@@ -210,11 +210,6 @@ that have not been merged into `main` and a PR proposes changes to
 `docs/architecture.md` could make changes to the documentation that mean that
 the changes to `docs/getting-started.md` are no longer accurate.
 
-If, after checking the community contributions on discourse, you determine that
-there are no logical conflicts, the `discourse-gatekeeper/discourse-ahead-ok` tag
-can be applied to the latest commit in the PR which will allow the action to
-proceed assuming there are no page-by-page conflicts.
-
 ## Contents Index
 
 The `docs/index.md` file may contain a `# contents` section which is used to

src-docs/__init__.py.md

@@ -51,7 +51,7 @@ Upload the documentation to charmhub.
 
 ---
 
-<a href="../src/__init__.py#L195"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/__init__.py#L191"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `run_migrate`
 
@@ -76,7 +76,7 @@ Migrate existing docs from charmhub to local repository.
 
 ---
 
-<a href="../src/__init__.py#L259"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/__init__.py#L255"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `pre_flight_checks`
 

src-docs/check.py.md

@@ -11,7 +11,7 @@ Module for running checks.
 
 ---
 
-<a href="../src/check.py#L55"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/check.py#L53"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `get_path_with_diffs`
 
@@ -37,15 +37,13 @@ Generate the paths that have either local or server content changes.
 
 ---
 
-<a href="../src/check.py#L161"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/check.py#L159"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `conflicts`
 
 ```python
 conflicts(
-    actions: Iterable[CreateGroupAction | CreatePageAction | CreateExternalRefAction | NoopGroupAction | NoopPageAction | NoopExternalRefAction | UpdateGroupAction | UpdatePageAction | UpdateExternalRefAction | DeleteGroupAction | DeletePageAction | DeleteExternalRefAction],
-    repository: Client,
-    user_inputs: UserInputs
+    actions: Iterable[CreateGroupAction | CreatePageAction | CreateExternalRefAction | NoopGroupAction | NoopPageAction | NoopExternalRefAction | UpdateGroupAction | UpdatePageAction | UpdateExternalRefAction | DeleteGroupAction | DeletePageAction | DeleteExternalRefAction]
 ) → Iterator[Problem]
 ```
 
@@ -60,8 +58,6 @@ The second type of conflict is a logical conflict which arises out of that there
 **Args:**
 
  - <b>`actions`</b>:  The actions to check. 
- - <b>`repository`</b>:  Client for repository interactions. 
- - <b>`user_inputs`</b>:  Configuration from the user. 
 
 
 
@@ -71,7 +67,7 @@ The second type of conflict is a logical conflict which arises out of that there
 
 ---
 
-<a href="../src/check.py#L273"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/check.py#L259"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `external_refs`
 

src-docs/constants.py.md

@@ -11,7 +11,6 @@ The use of this module should be limited to cases where the constant is not bett
 ---------------
 - **DEFAULT_BRANCH**
 - **DOCUMENTATION_TAG**
-- **DISCOURSE_AHEAD_TAG**
 - **DOCUMENTATION_FOLDER_NAME**
 - **DOC_FILE_EXTENSION**
 - **DOCUMENTATION_INDEX_FILENAME**

src/__init__.py

@@ -147,11 +147,7 @@ def run_reconcile(clients: Clients, user_inputs: UserInputs) -> ReconcileOutputs
         )
 
     actions, check_actions = tee(actions, 2)
-    problems = tuple(
-        check.conflicts(
-            actions=check_actions, repository=clients.repository, user_inputs=user_inputs
-        )
-    )
+    problems = tuple(check.conflicts(actions=check_actions))
     if problems:
         raise InputError(
             "One or more of the required actions could not be executed, see the log for details"

src/check.py

@@ -10,17 +10,15 @@
 
 import requests
 
-from src import constants, content
+from src import content
 from src.constants import DOCUMENTATION_TAG
-from src.repository import Client
 from src.types_ import (
     AnyAction,
     IndexContentsListItem,
     UpdateAction,
     UpdateExternalRefAction,
     UpdateGroupAction,
     UpdatePageAction,
-    UserInputs,
 )
 
 
@@ -158,9 +156,7 @@ def _update_action_problem(action: UpdateAction) -> Problem | None:
     return problem
 
 
-def conflicts(
-    actions: Iterable[AnyAction], repository: Client, user_inputs: UserInputs
-) -> Iterator[Problem]:
+def conflicts(actions: Iterable[AnyAction]) -> Iterator[Problem]:
     """Check whether actions have any content conflicts.
 
     There are two types of conflicts. The first is where the local content is different to what is
@@ -176,8 +172,6 @@ def conflicts(
 
     Args:
         actions: The actions to check.
-        repository: Client for repository interactions.
-        user_inputs: Configuration from the user.
 
     Yields:
         A problem for each action with a conflict
@@ -196,12 +190,6 @@ def conflicts(
     if any_page_conflicts:
         return
 
-    commit_discourse_ahead_ok_tagged = repository.is_same_commit(
-        tag=constants.DISCOURSE_AHEAD_TAG, commit=user_inputs.commit_sha
-    )
-    if commit_discourse_ahead_ok_tagged:
-        return
-
     paths_with_diff = get_path_with_diffs(actions_logical_conflicts)
     if not paths_with_diff.base_local_diffs or not paths_with_diff.base_server_diffs:
         return
@@ -210,9 +198,7 @@ def conflicts(
         path=paths_with_diff.base_local_diffs[0],
         description=(
             "detected unmerged community contributions, these need to be resolved "
-            "before proceeding. If the differences are not conflicting, please apply the "
-            f"{constants.DISCOURSE_AHEAD_TAG} tag to commit {user_inputs.commit_sha} to "
-            "proceed. Paths with potentially unmerged community contributions: "
+            "before proceeding.  Paths with potentially unmerged community contributions: "
             f"{set(chain(paths_with_diff.base_local_diffs, paths_with_diff.base_server_diffs))}."
         ),
     )

src/constants.py

@@ -8,7 +8,6 @@
 """
 DEFAULT_BRANCH = "main"
 DOCUMENTATION_TAG = "discourse-gatekeeper/base-content"
-DISCOURSE_AHEAD_TAG = "discourse-gatekeeper/discourse-ahead-ok"
 
 DOCUMENTATION_FOLDER_NAME = "docs"
 DOC_FILE_EXTENSION = ".md"

tests/integration/test___init__run_conflict.py

@@ -20,7 +20,7 @@
 from github.ContentFile import ContentFile
 
 from src import Clients, constants, exceptions, metadata, repository, run_reconcile
-from src.constants import DEFAULT_BRANCH, DISCOURSE_AHEAD_TAG, DOCUMENTATION_TAG
+from src.constants import DEFAULT_BRANCH, DOCUMENTATION_TAG
 from src.discourse import Discourse
 
 from .. import factories
@@ -49,16 +49,13 @@ async def test_run_conflict(
         5. docs with an index and documentation and alternate documentation file
         6. docs with an index and changed documentation and alternate documentation with server
             changes
-        7. docs with an index and changed documentation and alternate documentation with server
-            changes with discourse-gatekeeper/discourse-ahead-ok applied
     assert: then:
         1. the documentation page is created
         2. the documentation page is not updated
         3. the documentation page is not updated
         4. the documentation page is updated
         5. the alternate documentation page is created
         6. the documentation page is not updated
-        6. the documentation page is updated
     """
     document_name = "name 1"
     caplog.set_level(logging.INFO)
@@ -260,7 +257,7 @@ async def test_run_conflict(
     # 6. docs with an index and changed documentation and alternate documentation with server
     # changes
     caplog.clear()
-    doc_file.write_text(doc_content_6 := f"# {doc_title}\ncontent 6", encoding="utf-8")
+    doc_file.write_text(f"# {doc_title}\ncontent 6", encoding="utf-8")
 
     repository_client.switch(DEFAULT_BRANCH).update_branch(
         "# 6. docs with an index and changed documentation and alternate documentation with "
@@ -300,34 +297,3 @@ async def test_run_conflict(
     assert doc_topic == doc_content_5
     alt_doc_topic = discourse_api.retrieve_topic(url=alt_doc_url)
     assert alt_doc_topic == alt_doc_topic_content_6
-
-    # 7. docs with an index and changed documentation and alternate documentation with server
-    # changes with discourse-gatekeeper/discourse-ahead-ok applied
-    caplog.clear()
-    repository_client.tag_commit(DISCOURSE_AHEAD_TAG, repository_client.current_commit)
-    mock_github_repo.get_contents.side_effect = [mock_alt_content_file, mock_content_file]
-
-    reconcile_output = run_reconcile(
-        clients=Clients(discourse=discourse_api, repository=repository_client),
-        user_inputs=factories.UserInputsFactory(
-            dry_run=False, delete_pages=True, commit_sha=repository_client.current_commit
-        ),
-    )
-
-    assert reconcile_output is not None
-    urls_with_actions = reconcile_output.topics
-
-    assert len(urls_with_actions) == 3
-    (alt_doc_url, _, _) = urls_with_actions.keys()
-    assert (urls := tuple(urls_with_actions)) == (alt_doc_url, doc_url, index_url)
-    assert_substrings_in_string(
-        chain(urls, (doc_table_line_1, alt_doc_table_line_5, "Update", "'success'")),
-        caplog.text,
-    )
-    index_topic = discourse_api.retrieve_topic(url=index_url)
-    assert doc_table_line_1 in index_topic
-    assert alt_doc_table_line_5 in index_topic
-    doc_topic = discourse_api.retrieve_topic(url=doc_url)
-    assert doc_topic == doc_content_6
-    alt_doc_topic = discourse_api.retrieve_topic(url=alt_doc_url)
-    assert alt_doc_topic == alt_doc_topic_content_6