Merge pull request #44 from saint-hilaire/rc/v2.2

Rc/v2.2

Author: belal-i

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Lampsible Contributing Guidelines
+
+Thank you for your interest in Lampsible. This document will help to make it easier
+for you to contribute code.
+
+## Setting up your development environment
+
+Something like this should work:
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -e .
+```
+
+## Branching guidelines
+
+All code changes are made through pull requests via the latest develop branch, currently `dev/v2`.
+Though not strictly required, it would be a big help if you name your topic branch
+something like `feature/gh-9-some-github-issue` or `bugfix/gh-10-other-github-issue`,
+and include that branch name into the header line of your commit message, something like this:
+```bash
+feature/gh-9-some-github-issue
+
+- Implement the feature like this or that.
+```
+
+
+## Unit tests
+
+If possible, please include unit tests for your changes. If you simply add it to
+_test/test_lampsible.py_, that should probably be fine.
+
+However, unit tests are a bit tricky in Lampsible. To run the tests, you need to
+provide an actual host on which Lampsible can install whatever it is you're trying to test.
+And as a word of caution, will install public facing web apps with insecure passwords!
+For this reason, unit tests are optional - if you omit this, I'll take care of it myself.
+At any rate, the easiest way to run the tests is to do something like this:
+
+```
+export [email protected]
+# These 2 aren't super important, if you omit them, the
+# Laravel tests will simply be skipped.
+export LAMPSIBLE_LARAVEL_NAME=my-laravel-app
+export LAMPSIBLE_LARAVEL_PATH=/path/to/my-laravel-app-2.0.tar.gz
+python -m unittest
+```
+
+Lampsible will install various things onto the host specified by `LAMPSIBLE_REMOTE`, so beware!
+This server should be insensitive in that regard. Also, Lampsible will set insecure passwords
+on that server, so again, beware! You should tear down that server after running tests.
+
+Also, if you run the whole test suite, at some point, the test
+will "fail" on the "Ansible side" because of some edge case
+related to Composer packages, caused by a non empty
+`composer_working_directory`. This is not really a problem.
+Lampsible is not intended to install Drupal, WordPress, etc, alongside
+each other on the same host. So to really run these tests, you
+should run them one at a time
+( `python -m unittest test.test_lampsible.TestLampsible.test_wordpress`, etc. ),
+and rebuild the server after each test case.
+
+The nature of Ansible automations - it requires some real remote server -
+poses a unique challenge with regards to unit tests. However,
+in spite of this little drawback, these tests are still quite convenient
+when you change the code but want to make sure nothing breaks.

README.md

@@ -207,43 +207,3 @@ If you want something similar with Docker, consider using [Docksible](https://gi
 another project that I maintain. It will install a web app onto your remote server with Docker Compose.
 It also leverages Ansible locally under the hood.
 
-## Contributing 
-
-Please do! I'd be more than happy to see Issues, Pull Requests and any other kind of feedback ;-)
-
-### Running unit tests
-
-```
-export [email protected]
-# These 2 aren't super important, if you omit them, the
-# Laravel tests will simply be skipped.
-export LAMPSIBLE_LARAVEL_NAME=my-laravel-app
-export LAMPSIBLE_LARAVEL_PATH=/path/to/my-laravel-app-2.0.tar.gz
-python -m unittest
-```
-
-Lampsible will install various things onto the host specified by `LAMPSIBLE_REMOTE`, so beware!
-This server should be insensitive in that regard. Also, Lampsible will set insecure passwords
-on that server, so again, beware! You should tear down that server after running tests.
-
-Also, these tests should be taken with a grain of salt. They are not true unit tests,
-When Lampsible runs, it calls Ansible playbooks under the hood, and when those playbooks
-finish running, Lampsible returns a status code of 0, no matter what happens on the
-remote server. And this status code is what the tests ultimately check.
-So when you run tests, you have to actually keep an eye on the console output
-printed by Ansible, as well as the results on your remote server.
-
-Also, if you run the whole test suite, at some point, the test
-will "fail" on the "Ansible side" because of some edge case
-related to Composer packages, caused by a non empty
-`composer_working_directory`. This is not really a problem.
-Lampsible is not intended to install Drupal, WordPress, etc, alongside
-each other on the same host. So to really run these tests, you
-should run them one at a time
-( `python -m unittest test.test_lampsible.TestLampsible.test_wordpress`, etc. ),
-and rebuild the server after each test case.
-
-The nature of Ansible automations - it requires some real remote server -
-poses a unique challenge with regards to unit tests. However,
-in spite of this little drawback, these tests are still quite convenient
-when you change the code but want to make sure nothing breaks.

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lampsible"
-version = "2.1.2"
+version = "2.2.0"
 authors = [
     {name="Brian St. Hilaire", email="[email protected]"}
 ]

src/lampsible/__init__.py

@@ -1 +1 @@
-__version__ = '2.1.2'
+__version__ = '2.2.0'

src/lampsible/arg_validator.py

@@ -195,21 +195,32 @@ def validate_database_args(self):
 
         default_database_names = {
             'wordpress': 'wordpress',
-            'joomla':    'joomla',
-            'drupal':    'drupal',
-            'laravel':   self.args.app_name,
+            'joomla'   : 'joomla',
+            'drupal'   : 'drupal',
+            'laravel'  : self.args.app_name,
+            'suitecrm' : 'suitecrm',
         }
 
         default_database_table_prefixes = {
             'wordpress': 'wp_',
             # TODO?
-            'joomla':    '',
-            'drupal':    '',
-            'laravel':   '',
+            'joomla'   : '',
+            'drupal'   : '',
+            'laravel'  : '',
+            'suitecrm' : '',
         }
-        if self.args.database_password \
-            and not self.args.insecure_cli_password:
 
+        if self.args.database_username == 'root':
+            print(dedent("""
+                'root' is an invalid database username. You probably want to
+                rerun this command with '--ask-database-root'.
+            """))
+            return 1
+
+        if (
+            self.args.database_password \
+                or self.args.database_root_password \
+        ) and not self.args.insecure_cli_password:
             print(INSECURE_CLI_PASS_WARNING)
             return 1
 
@@ -218,6 +229,7 @@ def validate_database_args(self):
             'joomla',
             'drupal',
             'laravel',
+            'suitecrm',
         ]:
             self.handle_defaults([
                 {
@@ -239,6 +251,14 @@ def validate_database_args(self):
                 },
             ], True, True)
 
+        if self.args.ask_database_root_password \
+                and not self.validated_args.database_root_password:
+            self.validated_args.database_root_password = self.get_pass_and_check(
+                'Please enter a database root password: ',
+                0,
+                True
+            )
+
         if self.validated_args.database_username and not self.validated_args.database_password:
             self.validated_args.database_password = self.get_pass_and_check(
                 'Please enter a database password: ',
@@ -281,6 +301,12 @@ def validate_ssl_args(self):
 
     def validate_php_args(self):
 
+        if self.args.php_version:
+            print(dedent("""
+                Warning! '--php-version' has been deprecated, and will be
+                removed in v3.
+                """))
+
         if self.args.action in [
             'apache',
             # TODO: But if 'mysql' was passed with '--php-myadmin',
@@ -515,6 +541,51 @@ def validate_app_args(self):
         return 0
 
 
+    def validate_suitecrm_args(self):
+        if self.args.action != 'suitecrm':
+            return 0
+
+        if self.args.suitecrm_version == '8':
+            self.handle_defaults([
+                {
+                    'arg_name': 'admin_username',
+                    'cli_default_value': None,
+                    'override_default_value': DEFAULT_ADMIN_USERNAME,
+                },
+            ], True, True)
+
+            if self.args.admin_password \
+                and not self.args.insecure_cli_password:
+                print(INSECURE_CLI_PASS_WARNING)
+                return 1
+
+            if not self.args.admin_password:
+                self.validated_args.admin_password = self.get_pass_and_check(
+                    "Please choose a password for the website's admin user: ",
+                    0,
+                    True
+                )
+
+        elif self.args.suitecrm_version == '7':
+            print(dedent("""
+                Warning! With SuiteCRM version 7, the admin credentials must
+                be supplied via web UI, which means anyone with web access to
+                the host can do it.
+                PLEASE IMMEDIATELY NAVIGATE TO YOUR WEB HOST, and complete the
+                installation... before someone else does it for you! ;-)
+                Also, you should use version 8 instead.
+                """))
+            print(dedent("""
+                Warning! Please be aware that SuiteCRM version 7 will not work
+                with PHP 8.3 or newer. Also, Lampsible's '--php-version' flag
+                is being deprecated, so you should set up your remote server
+                with a distro that uses PHP 8.2 or older by default,
+                like for example Ubuntu 22.
+                """))
+
+        return 0
+
+
     def validate_misc_args(self):
         try:
             self.validated_args.extra_packages = self.args.extra_packages.split(',')
@@ -584,6 +655,7 @@ def validate_args(self):
             'validate_joomla_args',
             'validate_drupal_args',
             'validate_app_args',
+            'validate_suitecrm_args',
             'validate_misc_args',
         ]
         for method_name in validate_methods: