documentation updates and 2.0.0 release preparation (rspace-os#31)

* update Changelog-OS.md
* update GettingStarted.md: add paragraph on hardware requirements
* update GettingStarted.md: note command variants when creating database/user
* clear obsolete slack webhook from test code

Author: mKowalski256

DevDocs/DeveloperNotes/GettingStarted/GettingStarted.md

@@ -1,10 +1,16 @@
 # Getting started with RSpace source code
 
-These instructions are for anyone wanting to run RSpace from source code
-on their local machine.
+These instructions are for anyone wanting to run RSpace from source code, on their local machine.
 
 ## Initial Setup
 
+### Recommended hardware
+
+For production setup we recommend a Linux-based server with at least 8Gb RAM. More details: 
+https://documentation.researchspace.com/article/q5dl9e6oz6-system-requirements-for-research-space
+
+For development you should be able to run all the code and tests fine with Linux/MacOS.  
+
 ### Install required software
 -   Install Java JDK17, use OpenJDK rather than Oracle.
 -   Install MariaDB 10.3.39, or later (MariaDB 11.3 is used fine on dockerized RSpace version)
@@ -116,14 +122,14 @@ mvn clean package -DskipTests=true -DgenerateReactDist=clean -DrenameResourcesMD
 You can also check top-level Jenkinsfile file to see how internal tests builds are created by
 ResearchSpace dev team (check 'Build prodRelease-like package' stage script).  
 
-### Set up MySQL database
+### Set up MariaDB/MySQL database
 
-#### MySQL initialisation
+#### MariaDB/MySQL initialisation
 
-Take these steps if you do not have MySQL or have a fresh installation of MySQL.
+Take these steps if you do not have MariaDB/MySQL or have a fresh installation of MariaDB/MySQL.
 
 ```bash
-# These steps are specific to Linux, adapt as needed
+# These steps are specific to Linux and MySQL5.7, adapt as needed
 
 # 1. Install the database package (your package manager might be apt, dnf, yum, ...)
 nix-env --install mysql57
@@ -170,25 +176,29 @@ After adding/updating the file and restarting mysql confirm that `SELECT @@sql_m
 #### RSpace table setup
 
 1.  Make sure MariaDB/MySQL is installed and running on your machine.
-2.  Set up an rspacedbuser user and rspace database on your MySQL using this command:
+2.  Set up an 'rspacedbuser' user and 'rspace' database on your MariaDB/MySQL using this command:
 
 ```bash
 mysql -u "root" -p"password" -e "
-  CREATE USER 'rspacedbuser'@'localhost' IDENTIFIED BY 'rspacedbpwd';
+  CREATE USER 'rspacedbuser'@'127.0.0.1' IDENTIFIED BY 'rspacedbpwd';
   CREATE DATABASE rspace collate 'utf8mb4_unicode_ci';
-  GRANT ALL ON rspace.* TO 'rspacedbuser'@'localhost';
+  GRANT ALL ON rspace.* TO 'rspacedbuser'@'127.0.0.1';
 "
 ```
-**NOTE:** on FIRST startup of Rspace with an empty rspace, dont skip the tests else liquibase fails (for unknown reasons),
-i.e. do not have -Dmaven.test.skip=true -Dmaven.site.skip=true -Dmaven.javadoc.skip=true
+**NOTE:** on FIRST startup of Rspace with an empty rspace, don't skip the tests else liquibase fails for unknown reasons;
+i.e. do not have `-Dmaven.test.skip=true -Dmaven.site.skip=true -Dmaven.javadoc.skip=true`
 in your launch config
 
+**NOTE:** depending on OS and DB used, your may need to change the username in creation/grant commands 
+from `'rspacedbuser'@'127.0.0.1'` to `'rspacedbuser'@'localhost'`. 
+You will know if running the tests/app gets you db authentication error for user `'rspacedbuser'@'localhost'`
+
 **NOTE:** if you subsequently drop the rspace DB, the rspacedbuser user will stay; do not try to recreate the user.
 
 At the end of this, you should be able to connect to the rspace database from
 your command line. with `bash mysql -urspacedbuser -prspacedbpwd rspace`.
 
-rspace is used for running acceptance tests and the application on localhost.
+'rspace' database is used for running acceptance tests and the application on localhost.
 
 ### Set up RSpace FileStore location
 

DevDocs/public/Changelog-OS.md

@@ -2,6 +2,14 @@ This document records significant changes to RSpace.
 It includes a summary of new features, bugfixes and server-side configuration changes.
 The intended audience is on-prem RSpace technical administrators who maintain RSpace.
 
+# 2.0.0 2024-06-26
+
+- first public release of open-source RSpace 
+
+# 2.0.0-RC2 2024-06-25
+
+- all project dependencies updated to versions available at https://github.com/rspace-os/ repos 
+
 # 2.0.0-RC1 2024-06-04
 
-- pre-release of open-source RSpace version 
+- private pre-release of open-source codebase of rspace-web project 

src/test/java/com/researchspace/service/ExternalMessageHandlerImplTest.java

@@ -142,7 +142,7 @@ private Map<String, String> getSlackDevDfg() {
     Map<String, String> map = new HashMap<>();
     map.put("SLACK_CHANNEL_NAME", "general");
     map.put("SLACK_TEAM_NAME", "rspacedev");
-    map.put("SLACK_WEBHOOK_URL", SlackPosterTest.RSPACEDEV_GENERAL_WEBHOOK);
+    map.put("SLACK_WEBHOOK_URL", SlackPosterTest.SLACK_WEBHOOK);
     map.put("SLACK_CHANNEL_LABEL", "general");
     map.put("SLACK_USER_ID", "U123");
     map.put("SLACK_TEAM_ID", "T456");

src/test/java/com/researchspace/slack/SlackPosterTest.java

@@ -8,18 +8,20 @@
 import java.net.URISyntaxException;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.client.RestTemplate;
 
+@Ignore("requires correct real secret webhook")
 @RunWith(ConditionalTestRunnerNotSpring.class)
 public class SlackPosterTest {
 
-  public static final String RSPACEDEV_GENERAL_WEBHOOK =
-      "https://hooks.slack.com/services/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";
+  public static final String SLACK_WEBHOOK =
+      "https://hooks.slack.com/services/<secret_webhook>";
 
   @Before
   public void setUp() throws Exception {}
@@ -35,8 +37,8 @@ public void test() throws URISyntaxException {
     String jsonMessage = SlackMessageTest.createAnySlackMessage(converted).toJSON();
 
     URI uri;
-    uri = new URI(RSPACEDEV_GENERAL_WEBHOOK);
-    HttpEntity<String> requestEntity = new HttpEntity<String>(jsonMessage);
+    uri = new URI(SLACK_WEBHOOK);
+    HttpEntity<String> requestEntity = new HttpEntity<>(jsonMessage);
     ResponseEntity<String> resp = template.postForEntity(uri, requestEntity, String.class);
     assertTrue(HttpStatus.OK.equals(resp.getStatusCode()));
   }