donaldkellett / homebrew-misc Goto Github PK

The formula donaldsebleung-com has been tested on Linux (Ubuntu 20.04 LTS) but has yet to be tested on macOS. Regarding this, the maintainer of this tap would like to invite macOS users to perform the test case as described below and report the results here plus the version of macOS used (e.g. Mojave, Catalina, Big Sur), along with a screen recording of the terminal and browser output if possible.

1. Ensure your Homebrew installation is up to date: $ brew update

2. Add the DonaldKellett/misc tap if you haven't already: $ brew tap DonaldKellett/misc

3. Install the formula donaldsebleung-com: $ brew install donaldsebleung-com

4. Check the exit code: $ echo $? It should be 0

5. Follow the instructions under the "Caveats" section for creating the appropriate symlinks:

   $ sudo ln -s "$(which donaldsebleung-com)" /usr/local/bin/donaldsebleung-com
   $ sudo ln -s "$(which java)" /usr/local/bin/java
   $ sudo ln -s "$(which openssl)" /usr/local/bin/openssl

6. Run the following command: $ donaldsebleung-com It should print a usage message

7. Check the exit code of the previous command: $ echo $? It should be 1

8. Get the version number of donaldsebleung-com: $ donaldsebleung-com get-version The output should be 0.1.0

9. Check the exit code of the previous command: $ echo $? It should be 0

10. Try to start the HTTPS server as a normal user: $ donaldsebleung-com start-service It should tell you to run this as root

11. Check the exit code of the previous command: $ echo $? It should be 1

12. Try to start the HTTPS server as root: $ sudo donaldsebleung-com start-service It should tell you that it is missing a key-certificate pair

13. Check the exit code of the previous command: $ echo $? It should be 1

14. Generate a self-signed key-certificate pair by issuing the following command: $ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 Use the passphrase averystrongP@ssw0rd when prompted

15. Install the key-certificate pair to donaldsebleung-com and tell it the passphrase:

    $ donaldsebleung-com install-key < key.pem
    $ donaldsebleung-com install-cert < cert.pem
    $ donaldsebleung-com set-passwd "averystrongP@ssw0rd"

16. Try to start the HTTPS server as root, again, and wait a few seconds: $ sudo donaldsebleung-com start-service

17. Visit https://localhost with a browser of your choice. You may (should) get a warning that the connection is not secure. Ignore the warning and proceed with the connection which should lead you to the webpage. If your browser does not give you the option of proceeding with a connection, consider installing Firefox and try again

18. Back in the terminal, press Ctrl-C to stop the HTTPS server

The formula cwtlbot-discord has been tested on Linux (Ubuntu 20.04 LTS) but not macOS at the time of writing. If you are a macOS user, the maintainer of this tap would like to invite you to perform a test case to ensure that cwtlbot-discord works on macOS as well. Submit your results of the test case by (1) indicating the version of macOS you are using (e.g. Mojave, Catalina, Big Sur) and (2) uploading a screen recording of you performing the test case.

Before performing the test case, ensure that:

1. The DonaldKellett/misc tap has been added: $ brew tap DonaldKellett/misc
2. The cwtlbot-discord formula is not installed: $ brew uninstall cwtlbot-discord
3. A Discord bot application has been set up and added to a server you have access to, with "Send Messages" permission at the bare minimum. To prevent spamming existing servers, you may wish to create a dedicated server for this test case.

The instructions for the test case are as follows:

1. Install the formula: $ brew install cwtlbot-discord

2. Check the exit code of the previous command: $ echo $? It should be 0

3. Display the help message: $ cwtlbot-discord --help. It should print:

   Usage:
     cwtlbot-discord [--init | --version]
   

4. Print version information: $ cwtlbot-discord --version The version should be 0.1.1

5. Check the exit code of the previous command: $ echo $? It should be 0

6. Run the initialization script and follow the setup instructions accordingly: $ cwtlbot-discord --init Note that terminal echo is suppressed when entering the login token so you cannot see what you have typed in (or pasted), much like entering your sudo password

7. Check the exit code of the previous command: $ echo $? It should be 0

8. Start the bot: $ cwtlbot-discord You should see the message "Logged in as ..." within a few seconds. Confirm that the bot account is now online as seen from the server

9. Paste the following link into the chat of the server containing the bot: https://www.codewars.com/kata/50654ddff44f800200000004/train/javascript The bot should respond with a multiline message starting with "Please refrain from posting links to the ..."

10. Press Ctrl-C in the terminal to stop the bot