Fix spelling

Author: spetrosi

CHANGELOG.md

@@ -633,7 +633,7 @@ Changelog
   - Add workarounds for known issues in SQL Server 2022
   - Use delay=3 timeout=40 in wait_for module to avoid unreachable server
 
-- Imrpove performance by intputting multiple SQL files with loop internaly (#116)
+- Improve performance by intputting multiple SQL files with loop internally (#116)
   - Make it possible to input multiple file with loop internally
   - Rename task file and vars for clarity
   - Make regex for files extension search more strict

README.md

@@ -98,7 +98,7 @@ The role uses `sqlcmd` for the following tasks:
 By default, installs and uses the latest version 18.
 
 You can set this variable to `[17, 18]` to install two versions in parallel.
-In the case when this variable contains multiple elements, the role instals both but uses latest provided version.
+In the case when this variable contains multiple elements, the role installs both but uses latest provided version.
 
 The role does not remove mssql-tools packages if you unset a version with this variable.
 
@@ -311,6 +311,7 @@ Type: `bool`
 
 #### Inputting SQL script files and content to SQL Server
 
+<!-- codespell:ignore-begin -->
 ```yaml
 - hosts: all
   vars:
@@ -358,6 +359,7 @@ Type: `bool`
         END
         GO
 ```
+<!-- codespell:ignore-end -->
 
 ## Installing Additional Packages
 
@@ -793,9 +795,9 @@ Default: `null`
 
 Type: `string`
 
-#### mssql_ha_master_key_password
+#### mssql_ha_master_key_password  <!-- codespell:ignore master -->
 
-The password to set for the master key used with the certificate.
+The password to set for the master key used with the certificate.<!-- codespell:ignore master -->
 
 Default: `null`
 
@@ -999,6 +1001,7 @@ all:
 ```
 
 Playbook:
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - hosts: all
@@ -1025,6 +1028,7 @@ Playbook:
   roles:
     - microsoft.sql.server
 ```
+<!-- codespell:ignore-end -->
 
 #### Configuring SQL Server with HA and Pacemaker on Bare Metal
 
@@ -1034,6 +1038,7 @@ This example configures required Pacemaker properties and resources and enables
 
 The `fedora.linux_system_roles.ha_cluster` role expects watchdog devices to be configured on `/dev/watchdog` by default, you can set a different device per host in inventory.
 For more information, see the `fedora.linux_system_roles.ha_cluster` role documentation.
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - hosts: all
@@ -1123,12 +1128,14 @@ For more information, see the `fedora.linux_system_roles.ha_cluster` role docume
     - microsoft.sql.server
 ```
 
+<!-- codespell:ignore-end -->
 #### Configuring SQL Server with HA and Pacemaker on VMWare
 
 If you want to configure Pacemaker from this role, you can set [mssql_manage_ha_cluster](#mssql_manage_ha_cluster) to `true` and provide variables required by the `fedora.linux_system_roles.ha_cluster` role to configure Pacemaker for your environment properly.
 See the `fedora.linux_system_roles.ha_cluster` role documentation for more information.
 
 Note that production environments require Pacemaker configured with fencing agents, this example playbook configures the `stonith:fence_vmware_soap` agent.
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - hosts: all
@@ -1226,6 +1233,7 @@ Note that production environments require Pacemaker configured with fencing agen
   roles:
     - microsoft.sql.server
 ```
+<!-- codespell:ignore-end -->
 
 #### Configuring SQL Server with HA and Pacemaker on Azure
 
@@ -1243,6 +1251,7 @@ See the `fedora.linux_system_roles.ha_cluster` role documentation for more infor
 Note that production environments require Pacemaker configured with fencing agents, this example playbook configures the `stonith:fence_azure_arm` agent.
 
 This example playbooks sets the `firewall` variables for the `fedora.linux_system_roles.firewall` role and then runs this role to open the probe port configured in Azure.
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - hosts: all
@@ -1371,6 +1380,7 @@ This example playbooks sets the `firewall` variables for the `fedora.linux_syste
     - fedora.linux_system_roles.firewall
     - microsoft.sql.server
 ```
+<!-- codespell:ignore-end -->
 
 ## Configuring SQL Server to authenticate with Active Directory (AD) Server
 
@@ -1569,6 +1579,7 @@ Type: `string`
 ### AD Example Playbooks
 
 #### Configuring AD integration with general parameters
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - name: Configure with AD server authentication
@@ -1607,10 +1618,12 @@ Type: `string`
         PRINT 'A <mydomain>\<myADlogin> login already exists, skipping'
       END
 ```
+<!-- codespell:ignore-end -->
 
 #### Configuring AD integration with a pre-created keytab file
 
 If you received a pre-created keytab file and want the role to use it, set variables like in this example:
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - name: Configure with AD server authentication with a pre-created keytab file
@@ -1649,10 +1662,12 @@ If you received a pre-created keytab file and want the role to use it, set varia
         PRINT 'A <mydomain>\<myADlogin> login already exists, skipping'
       END
 ```
+<!-- codespell:ignore-end -->
 
 #### Configuring AD integration without joining to AD
 
 You must join managed host to AD Server yourself prior to running this playbook.
+<!-- codespell:ignore-begin -->
 
 ```yaml
 - name: Configure with AD server authentication without joining to AD
@@ -1687,6 +1702,7 @@ You must join managed host to AD Server yourself prior to running this playbook.
         PRINT 'A <mydomain>\<myADlogin> login already exists, skipping'
       END
 ```
+<!-- codespell:ignore-end -->
 
 ## License
 

defaults/main.yml

@@ -47,7 +47,7 @@ mssql_ha_replica_type: null
 mssql_ha_endpoint_port: 5022
 mssql_ha_cert_name: null
 mssql_ha_private_key_password: null
-mssql_ha_master_key_password: null
+mssql_ha_master_key_password: null  # codespell:ignore master
 mssql_ha_reset_cert: false
 mssql_ha_endpoint_name: null
 mssql_ha_ag_name: null

tasks/main.yml

@@ -1210,7 +1210,7 @@
         - name: Configure SQL entities on the primary replica
           vars:
             __mssql_sql_files_to_input:
-              - create_master_key_encryption.j2
+              - create_master_key_encryption.j2  # codespell:ignore master
               - create_and_back_up_cert.j2
               - enable_alwayson.j2
               - configure_endpoint.j2
@@ -1382,7 +1382,7 @@
           vars:
             __mssql_sql_files_to_input:
               - enable_alwayson.j2
-              - create_master_key_encryption.j2
+              - create_master_key_encryption.j2  # codespell:ignore master
               - restore_cert.j2
               - configure_endpoint.j2
           include_tasks: input_sql_files.yml

templates/create_and_back_up_cert.j2

@@ -3,9 +3,9 @@
 SET NOCOUNT ON;
 
 DECLARE @cerExists INT;
-EXEC master.dbo.xp_fileexist '{{ __mssql_ha_cert_dest }}', @cerExists OUTPUT;
+EXEC master.dbo.xp_fileexist '{{ __mssql_ha_cert_dest }}', @cerExists OUTPUT;  {# codespell:ignore master #}
 DECLARE @pvkExists INT;
-EXEC master.dbo.xp_fileexist '{{ __mssql_ha_private_key_dest }}',
+EXEC master.dbo.xp_fileexist '{{ __mssql_ha_private_key_dest }}',  {# codespell:ignore master #}
   @pvkExists OUTPUT;
 
 IF NOT EXISTS(

templates/create_ha_login.j2

@@ -1,4 +1,4 @@
-USE master;
+USE master;  {# codespell:ignore master #}
 IF NOT EXISTS (
   SELECT name FROM sys.server_principals
   WHERE name = '{{ mssql_ha_login }}'

templates/create_master_key_encryption.j2

@@ -6,31 +6,31 @@ IF NOT EXISTS (
 BEGIN
   PRINT 'Master key does not exist, creating';
   CREATE MASTER KEY ENCRYPTION BY PASSWORD =
-    '{{ mssql_ha_master_key_password }}';
+    '{{ mssql_ha_master_key_password }}';  {# codespell:ignore master #}
   PRINT 'Master key created successfully';
 END
 ELSE
 BEGIN
   PRINT 'Master key already exists, verifying the provided password against \
-the existing master key';
+the existing master key';  {# codespell:ignore master #}
   BEGIN TRY
     OPEN MASTER KEY DECRYPTION BY PASSWORD =
-      '{{ mssql_ha_master_key_password }}';
-    PRINT 'The provided master key password is correct';
+      '{{ mssql_ha_master_key_password }}';  {# codespell:ignore master #}
+    PRINT 'The provided master key password is correct';  {# codespell:ignore master #}
   END TRY
   BEGIN CATCH
 {% if not mssql_ha_reset_cert %}
-    PRINT 'You provided an incorrect master key password with the \
-mssql_ha_master_key_password variable';
+    PRINT 'You provided an incorrect master key password with the \  {# codespell:ignore master #}
+mssql_ha_master_key_password variable';  {# codespell:ignore master #}
     THROW;
 {% elif mssql_ha_reset_cert %}
     PRINT 'Master key password provided with the \
-mssql_ha_master_key_password variable does not match the existing password, \
-dropping master key to re-create it';
+mssql_ha_master_key_password variable does not match the existing password, \  {# codespell:ignore master #}
+dropping master key to re-create it';  {# codespell:ignore master #}
     DROP MASTER KEY;
     PRINT 'Master key dropped successfully';
     CREATE MASTER KEY ENCRYPTION BY PASSWORD =
-      '{{ mssql_ha_master_key_password }}';
+      '{{ mssql_ha_master_key_password }}';  {# codespell:ignore master #}
     PRINT 'Master key created successfully';
 {% endif %}
   END CATCH

templates/replicate_db.j2

@@ -44,16 +44,16 @@ IF NOT EXISTS (
   ISNULL(dbrs.synchronization_state, 0) AS [SynchronizationState],
   ISNULL(dbrs.is_suspended, 0) AS [IsSuspended],
   ISNULL(dbcs.is_database_joined, 0) AS [IsJoined]
-  FROM master.sys.availability_groups AS AG
-  LEFT OUTER JOIN master.sys.dm_hadr_availability_group_states as agstates
+  FROM master.sys.availability_groups AS AG  {# codespell:ignore master #}
+  LEFT OUTER JOIN master.sys.dm_hadr_availability_group_states as agstates  {# codespell:ignore master #}
     ON AG.group_id = agstates.group_id
-  INNER JOIN master.sys.availability_replicas AS AR
+  INNER JOIN master.sys.availability_replicas AS AR  {# codespell:ignore master #}
     ON AG.group_id = AR.group_id
-  INNER JOIN master.sys.dm_hadr_availability_replica_states AS arstates
+  INNER JOIN master.sys.dm_hadr_availability_replica_states AS arstates  {# codespell:ignore master #}
     ON AR.replica_id = arstates.replica_id AND arstates.is_local = 1
-  INNER JOIN master.sys.dm_hadr_database_replica_cluster_states AS dbcs
+  INNER JOIN master.sys.dm_hadr_database_replica_cluster_states AS dbcs  {# codespell:ignore master #}
     ON arstates.replica_id = dbcs.replica_id
-  LEFT OUTER JOIN master.sys.dm_hadr_database_replica_states AS dbrs
+  LEFT OUTER JOIN master.sys.dm_hadr_database_replica_states AS dbrs  {# codespell:ignore master #}
     ON dbcs.replica_id = dbrs.replica_id
     AND dbcs.group_database_id = dbrs.group_database_id
   WHERE dbcs.database_name = '{{ item }}'

tests/files/sql_script.sql

@@ -1,6 +1,6 @@
 IF NOT EXISTS (
   SELECT name
-  FROM master.sys.server_principals
+  FROM master.sys.server_principals  {# codespell:ignore master #}
   WHERE name = 'MyLogin'
 )
 BEGIN
@@ -64,4 +64,4 @@ ELSE
 BEGIN
   PRINT 'The Inventory table already exists, skipping';
 END
-GO
+GO

tests/playbooks/tests_ad_integration.yml

@@ -45,6 +45,7 @@
     # mssql_ad_join: false does ad_integration_user: null
     __mssql_ad_login: >-
       {{ ad_integration_realm.split('.') | first + '\Administrator' }}
+    # codespell:ignore-begin
     mssql_post_input_sql_content: |-
       USE master;
       IF NOT EXISTS (
@@ -60,6 +61,7 @@
       BEGIN
         PRINT 'A {{ __mssql_ad_login }} login already exists, skipping'
       END
+    # codespell:ignore-end
 
   tasks:
     # Test general scenario