From 4d937a4a025067851e030afa9e36c5064a694df4 Mon Sep 17 00:00:00 2001 From: Rajesh Tailor Date: Mon, 27 Jun 2022 16:56:49 +0530 Subject: [PATCH] Fix typos in parameter descriptions and tests Change-Id: Ic91d910b973303b0d4db5164fdf9b5fd807a4f70 --- README.md | 4 ++-- lib/puppet/provider/service/swiftinit.rb | 2 +- manifests/containerreconciler.pp | 4 ++-- manifests/deps.pp | 2 +- manifests/init.pp | 4 ++-- manifests/keymaster.pp | 4 ++-- manifests/objectexpirer.pp | 4 ++-- manifests/proxy/cache.pp | 4 ++-- manifests/proxy/ceilometer.pp | 2 +- manifests/proxy/domain_remap.pp | 2 +- manifests/proxy/gatekeeper.pp | 2 +- manifests/proxy/s3api.pp | 2 +- manifests/proxy/slo.pp | 2 +- manifests/proxy/swauth.pp | 2 +- manifests/proxy/tempauth.pp | 2 +- manifests/ringbuilder.pp | 4 ++-- manifests/ringbuilder/policy_ring.pp | 4 ++-- manifests/storage/disk.pp | 2 +- manifests/storage/ext4.pp | 2 +- manifests/storage/xfs.pp | 5 +++-- spec/classes/swift_containerreconciler_spec.rb | 2 +- spec/classes/swift_memcache_spec.rb | 2 +- spec/classes/swift_objectexpirer_spec.rb | 2 +- spec/classes/swift_test_file_spec.rb | 2 +- spec/defines/swift_ringbuilder_create_spec.rb | 2 +- .../provider/swift_account_uwsgi_config/ini_setting_spec.rb | 2 +- .../swift_container_uwsgi_config/ini_setting_spec.rb | 2 +- .../provider/swift_proxy_uwsgi_config/ini_setting_spec.rb | 2 +- spec/unit/puppet/provider/swift_storage_policy/ruby.rb | 2 +- templates/swift_keystone_test.erb | 2 +- 30 files changed, 40 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 1db0fd37..9dcb3fae 100644 --- a/README.md +++ b/README.md @@ -451,7 +451,7 @@ a templated init or services file. This is managed by this provider. For EL and Moving from the default service providers to the swiftinit service provider is supported. On the next puppet run after setting the swiftinit service provider swift services are stopped on the old provider and immediately started using swift-init. This provides a supported upgrade path with no downtime. The swiftinit service provider uses the following service type parameters to -manage swift services in a non standard way. +manage swift services in a non-standard way. * `manifest` is used to pass in the config file the service should be configured with. Ex `object-server.conf` @@ -462,7 +462,7 @@ To aid with input validation to the swiftinit provider there is a defined type s ### Class: swift::service This is a wrapper defined type for the swift service providers. -It provides a centraziled location to manage and validate input for use to the default +It provides a centralized location to manage and validate input for use to the default and swiftinit service providers. ####`namevar` diff --git a/lib/puppet/provider/service/swiftinit.rb b/lib/puppet/provider/service/swiftinit.rb index 7e8411b5..cdbc7faa 100644 --- a/lib/puppet/provider/service/swiftinit.rb +++ b/lib/puppet/provider/service/swiftinit.rb @@ -91,7 +91,7 @@ Puppet::Type.type(:service).provide :swiftinit, :parent => :service do end end - # Disable the service at boot. For Redhat and Debain, + # Disable the service at boot. For Redhat and Debian, # delete services file and notify systemctl. For Ubuntu < 16.04 # remove init file. def disable diff --git a/manifests/containerreconciler.pp b/manifests/containerreconciler.pp index 90802db0..6c37d855 100644 --- a/manifests/containerreconciler.pp +++ b/manifests/containerreconciler.pp @@ -49,7 +49,7 @@ # Defaults to ['127.0.0.1:11211'] # # [*cache_tls_enabled*] -# (Optional) Global toggle for TLS usage when comunicating with +# (Optional) Global toggle for TLS usage when communicating with # the caching servers. # Default to false # @@ -69,7 +69,7 @@ # # [*cache_tls_keyfile*] # (Optional) Path to a single file containing the client's private -# key in. Otherwhise the private key will be taken from the file +# key in. Otherwise the private key will be taken from the file # specified in tls_certfile. If tls_enabled is False, this option # is ignored. # Defaults to $::os_service_default diff --git a/manifests/deps.pp b/manifests/deps.pp index 12a827a0..8967aec6 100644 --- a/manifests/deps.pp +++ b/manifests/deps.pp @@ -68,7 +68,7 @@ class swift::deps { # Support packages need to be installed in the install phase, but we don't # put them in the chain above because we don't want any false dependencies # between packages with the swift-package tag and the swift-support-package - # tag. Note: the package resources here will have a 'before' relationshop on + # tag. Note: the package resources here will have a 'before' relationship on # the swift::install::end anchor. The line between swift-support-package and # swift-package should be whether or not swift services would need to be # restarted if the package state was changed. diff --git a/manifests/init.pp b/manifests/init.pp index 084369bc..e004fd78 100644 --- a/manifests/init.pp +++ b/manifests/init.pp @@ -7,7 +7,7 @@ # when generating hashes for paths. It simply appends this value to all # paths; if someone knows this suffix, it's easier for them to guess the hash # a path will end up with. New installations are advised to set this -# parameter to a random secret, which would not be disclosed ouside the +# parameter to a random secret, which would not be disclosed outside the # organization. The same secret needs to be used by all swift servers of the # same cluster. Existing installations should set this parameter to an empty # string. @@ -17,7 +17,7 @@ # when generating hashes for paths. It simply prepends this value to all paths; # if someone knows this prefix, it's easier for them to guess the hash a path # will end up with. New installations are advised to set this parameter to a -# random secret, which would not be disclosed ouside the organization. The +# random secret, which would not be disclosed outside the organization. The # same secret needs to be used by all swift servers of the same cluster. # Existing installations should set this parameter to an empty string. # as a salt when hashing to determine mappings in the ring. diff --git a/manifests/keymaster.pp b/manifests/keymaster.pp index 7be8ec9d..b5d9fda2 100644 --- a/manifests/keymaster.pp +++ b/manifests/keymaster.pp @@ -41,10 +41,10 @@ # [filter:authtoken] in proxy-server.conf. # # [*project_domain_name*] -# (Optional) String. The project domain name may optionally be specififed. +# (Optional) String. The project domain name may optionally be specified. # # [*user_domain_name*] -# (Optional) String. The user domain name may optionally be specififed. +# (Optional) String. The user domain name may optionally be specified. # # [*project_domain_id*] # (Optional) String. Instead of the project domain name, the project domain diff --git a/manifests/objectexpirer.pp b/manifests/objectexpirer.pp index 53b368be..3d81cd28 100644 --- a/manifests/objectexpirer.pp +++ b/manifests/objectexpirer.pp @@ -72,7 +72,7 @@ # Defaults to ['127.0.0.1:11211'] # # [*cache_tls_enabled*] -# (Optional) Global toggle for TLS usage when comunicating with +# (Optional) Global toggle for TLS usage when communicating with # the caching servers. # Default to false # @@ -92,7 +92,7 @@ # # [*cache_tls_keyfile*] # (Optional) Path to a single file containing the client's private -# key in. Otherwhise the private key will be taken from the file +# key in. Otherwise the private key will be taken from the file # specified in tls_certfile. If tls_enabled is False, this option # is ignored. # Defaults to undef diff --git a/manifests/proxy/cache.pp b/manifests/proxy/cache.pp index 6ab87c17..f4b5f007 100644 --- a/manifests/proxy/cache.pp +++ b/manifests/proxy/cache.pp @@ -5,7 +5,7 @@ # should be in the form host:port. # # [*tls_enabled*] -# (Optional) Global toggle for TLS usage when comunicating with +# (Optional) Global toggle for TLS usage when communicating with # the caching servers. # Default to false # @@ -25,7 +25,7 @@ # # [*tls_keyfile*] # (Optional) Path to a single file containing the client's private -# key in. Otherwhise the private key will be taken from the file +# key in. Otherwise the private key will be taken from the file # specified in tls_certfile. If tls_enabled is False, this option # is ignored. # Defaults to undef diff --git a/manifests/proxy/ceilometer.pp b/manifests/proxy/ceilometer.pp index 44e429dd..b330ddf5 100644 --- a/manifests/proxy/ceilometer.pp +++ b/manifests/proxy/ceilometer.pp @@ -163,7 +163,7 @@ class swift::proxy::ceilometer( } if $auth_uri { - warning('The swift::proxy::ceilometer::auth_uri parameter was deperecated, and has no effect') + warning('The swift::proxy::ceilometer::auth_uri parameter was deprecated, and has no effect') } if $password == undef { diff --git a/manifests/proxy/domain_remap.pp b/manifests/proxy/domain_remap.pp index 933e5adc..3b162d00 100644 --- a/manifests/proxy/domain_remap.pp +++ b/manifests/proxy/domain_remap.pp @@ -55,7 +55,7 @@ # # [*default_reseller_prefix*] # The default reseller_prefix. -# It will be used if none of reseller_prexies match +# It will be used if none of reseller_prefixes match # Default to $::os_service_default # # [*mangle_client_paths*] diff --git a/manifests/proxy/gatekeeper.pp b/manifests/proxy/gatekeeper.pp index 3f7f2b62..7f8ad74b 100644 --- a/manifests/proxy/gatekeeper.pp +++ b/manifests/proxy/gatekeeper.pp @@ -8,7 +8,7 @@ # == Parameters # # [*shunt_inbound_x_timestamp*] -# (Optional) Disallow clients to set arbitary X-Timestamps on uploade objects. +# (Optional) Disallow clients to set arbitrary X-Timestamps on uploaded objects. # Defaults to $::os_service_default. # # [*allow_reserved_names_header*] diff --git a/manifests/proxy/s3api.pp b/manifests/proxy/s3api.pp index 6d2ccb97..715b92b7 100644 --- a/manifests/proxy/s3api.pp +++ b/manifests/proxy/s3api.pp @@ -18,7 +18,7 @@ # Defaults to $::os_service_default. # # [*max_bucket_listing*] -# The default maximum nuber of objects returned in the GET Bucket response. +# The default maximum number of objects returned in the GET Bucket response. # Defaults to $::os_service_default. # # [*max_parts_listing*] diff --git a/manifests/proxy/slo.pp b/manifests/proxy/slo.pp index b7324128..9994cbeb 100644 --- a/manifests/proxy/slo.pp +++ b/manifests/proxy/slo.pp @@ -44,7 +44,7 @@ # Defaults to $::os_service_default. # # [*yield_frequency*] -# (Optional) Frequency, in seconds, to yield whitespace ahed of the final +# (Optional) Frequency, in seconds, to yield whitespace ahead of the final # response. # Defaults to $::os_service_default. # diff --git a/manifests/proxy/swauth.pp b/manifests/proxy/swauth.pp index a3388cbb..e9e739f2 100644 --- a/manifests/proxy/swauth.pp +++ b/manifests/proxy/swauth.pp @@ -7,7 +7,7 @@ # Defaults to 'present' # # [*swauth_endpoint*] -# (optional) The endpoint used to autenticate to Swauth WSGI. +# (optional) The endpoint used to authenticate to Swauth WSGI. # Defaults to '127.0.0.1' # # [*swauth_super_admin_key*] diff --git a/manifests/proxy/tempauth.pp b/manifests/proxy/tempauth.pp index a5513c32..64134b61 100644 --- a/manifests/proxy/tempauth.pp +++ b/manifests/proxy/tempauth.pp @@ -57,7 +57,7 @@ # }, # ] # -# it will gerenate these lines +# it will generate these lines # user_admin_admin = admin .admin .reseller_admin # user_bar_foo = pass # diff --git a/manifests/ringbuilder.pp b/manifests/ringbuilder.pp index de11898a..5a183a31 100644 --- a/manifests/ringbuilder.pp +++ b/manifests/ringbuilder.pp @@ -1,5 +1,5 @@ # Used to configure nodes that are responsible for managing swift rings. -# Rings are used to make decicions about how to map objects in the cluster +# Rings are used to make decisions about how to map objects in the cluster # # Specifies the following relationship: # Rings should be created before any devices are added to them @@ -7,7 +7,7 @@ # == Parameters # [*part_power*] The total number of partitions that should exist in the ring. # This is expressed as a power of 2. -# [*replicas*] Numer of replicas that should be maintained of each stored object. +# [*replicas*] Number of replicas that should be maintained of each stored object. # [*min_part_hours*] Minimum amount of time before partitions can be moved. # # == Dependencies diff --git a/manifests/ringbuilder/policy_ring.pp b/manifests/ringbuilder/policy_ring.pp index 559b9a56..ee93cce4 100644 --- a/manifests/ringbuilder/policy_ring.pp +++ b/manifests/ringbuilder/policy_ring.pp @@ -1,4 +1,4 @@ -# Used to build an aditional object ring for a storage policy. +# Used to build an additional object ring for a storage policy. # The namevar/name of this class must be an integer. # # @@ -11,7 +11,7 @@ # # [*part_power*] The total number of partitions that should exist in the ring. # This is expressed as a power of 2. -# [*replicas*] Numer of replicas that should be maintained of each stored object. +# [*replicas*] Number of replicas that should be maintained of each stored object. # [*min_part_hours*] Minimum amount of time before partitions can be moved. # # == Dependencies diff --git a/manifests/storage/disk.pp b/manifests/storage/disk.pp index f961561b..4e24f2b6 100644 --- a/manifests/storage/disk.pp +++ b/manifests/storage/disk.pp @@ -41,7 +41,7 @@ # # [*manage_filesystem*] # (optional) If set to false, skip calling xfs_admin -l to check if a -# partition needs to be formated with mkfs.xfs, which can, in some cases, +# partition needs to be formatted with mkfs.xfs, which can, in some cases, # increase the load on the server. This is to set to false only after the # server is fully setup, or if the filesystem was created outside of puppet. # Defaults to true. diff --git a/manifests/storage/ext4.pp b/manifests/storage/ext4.pp index 4b527b50..7ef16376 100644 --- a/manifests/storage/ext4.pp +++ b/manifests/storage/ext4.pp @@ -16,7 +16,7 @@ # [*byte_size*] # (optional) The byte size that dd uses when it creates the file system. # Defaults to '1024', block size for the disk. For very large partitions, this should be larger -# It is recommened to use 1024 to ensure that the metadata can fit in a single inode. +# It is recommend to use 1024 to ensure that the metadata can fit in a single inode. # # [*loopback*] # (optional) Define if the device must be mounted as a loopback or not diff --git a/manifests/storage/xfs.pp b/manifests/storage/xfs.pp index 8c8b9bad..718dd7e6 100644 --- a/manifests/storage/xfs.pp +++ b/manifests/storage/xfs.pp @@ -11,7 +11,8 @@ # # [*byte_size*] # (optional) Byte size to use for every inode in the created filesystem. -# Defaults to '1024'. It is recommened to use 1024 to ensure that the metadata can fit in a single inode. +# Defaults to '1024'. It is recommended to use 1024 to ensure that the metadata can fit +# in a single inode. # # [*loopback*] # (optional) Define if the device must be mounted as a loopback or not @@ -23,7 +24,7 @@ # # [*manage_filesystem*] # (optional) If set to false, skip calling xfs_admin -l to check if a -# partition needs to be formated with mkfs.xfs, which can, in some cases, +# partition needs to be formatted with mkfs.xfs, which can, in some cases, # increase the load on the server. This is to set to false only after the # server is fully setup, or if the filesystem was created outside of puppet. # Defaults to true. diff --git a/spec/classes/swift_containerreconciler_spec.rb b/spec/classes/swift_containerreconciler_spec.rb index fe5494d4..3375ab66 100644 --- a/spec/classes/swift_containerreconciler_spec.rb +++ b/spec/classes/swift_containerreconciler_spec.rb @@ -48,7 +48,7 @@ describe 'swift::containerreconciler' do end end - context 'when overridding parameters' do + context 'when overriding parameters' do before do params.merge!( :interval => '600', diff --git a/spec/classes/swift_memcache_spec.rb b/spec/classes/swift_memcache_spec.rb index 8ba29a8e..0fcb34ab 100644 --- a/spec/classes/swift_memcache_spec.rb +++ b/spec/classes/swift_memcache_spec.rb @@ -33,7 +33,7 @@ describe 'swift::memcache' do 'memcache/io_timeout').with_value('') } end - describe 'when overridding parameters' do + describe 'when overriding parameters' do let :params do { :memcache_servers => ['1.1.1.1:11211', '2.2.2.2:11211'], diff --git a/spec/classes/swift_objectexpirer_spec.rb b/spec/classes/swift_objectexpirer_spec.rb index 08cb0a8c..7c27d60d 100644 --- a/spec/classes/swift_objectexpirer_spec.rb +++ b/spec/classes/swift_objectexpirer_spec.rb @@ -74,7 +74,7 @@ describe 'swift::objectexpirer' do end end - context 'when overridding parameters' do + context 'when overriding parameters' do before do params.merge!( :interval => '600', diff --git a/spec/classes/swift_test_file_spec.rb b/spec/classes/swift_test_file_spec.rb index a992f644..b8b577a8 100644 --- a/spec/classes/swift_test_file_spec.rb +++ b/spec/classes/swift_test_file_spec.rb @@ -23,7 +23,7 @@ describe 'swift::test_file' do end end - describe 'when overridding' do + describe 'when overriding' do let :params do default_params.merge({ :auth_server => '127.0.0.2', diff --git a/spec/defines/swift_ringbuilder_create_spec.rb b/spec/defines/swift_ringbuilder_create_spec.rb index 3232fb6d..70e406f4 100644 --- a/spec/defines/swift_ringbuilder_create_spec.rb +++ b/spec/defines/swift_ringbuilder_create_spec.rb @@ -24,7 +24,7 @@ describe 'swift::ringbuilder::create' do :min_part_hours => 2, :user => 'root'}].each do |param_set| - describe "when #{param_set == {} ? "using default" : "specifying"} class parame ters" do + describe "when #{param_set == {} ? "using default" : "specifying"} class parameters" do let :param_hash do default_params.merge(param_set) end diff --git a/spec/unit/provider/swift_account_uwsgi_config/ini_setting_spec.rb b/spec/unit/provider/swift_account_uwsgi_config/ini_setting_spec.rb index 93c99902..5aa2c4c7 100644 --- a/spec/unit/provider/swift_account_uwsgi_config/ini_setting_spec.rb +++ b/spec/unit/provider/swift_account_uwsgi_config/ini_setting_spec.rb @@ -2,7 +2,7 @@ # these tests are a little concerning b/c they are hacking around the # modulepath, so these tests will not catch issues that may eventually arise # related to loading these plugins. -# I could not, for the life of me, figure out how to programatcally set the modulepath +# I could not, for the life of me, figure out how to programmatically set the modulepath $LOAD_PATH.push( File.join( File.dirname(__FILE__), diff --git a/spec/unit/provider/swift_container_uwsgi_config/ini_setting_spec.rb b/spec/unit/provider/swift_container_uwsgi_config/ini_setting_spec.rb index 7216c19b..d3370620 100644 --- a/spec/unit/provider/swift_container_uwsgi_config/ini_setting_spec.rb +++ b/spec/unit/provider/swift_container_uwsgi_config/ini_setting_spec.rb @@ -2,7 +2,7 @@ # these tests are a little concerning b/c they are hacking around the # modulepath, so these tests will not catch issues that may eventually arise # related to loading these plugins. -# I could not, for the life of me, figure out how to programatcally set the modulepath +# I could not, for the life of me, figure out how to programmatically set the modulepath $LOAD_PATH.push( File.join( File.dirname(__FILE__), diff --git a/spec/unit/provider/swift_proxy_uwsgi_config/ini_setting_spec.rb b/spec/unit/provider/swift_proxy_uwsgi_config/ini_setting_spec.rb index 3cd39bad..a2148d8b 100644 --- a/spec/unit/provider/swift_proxy_uwsgi_config/ini_setting_spec.rb +++ b/spec/unit/provider/swift_proxy_uwsgi_config/ini_setting_spec.rb @@ -2,7 +2,7 @@ # these tests are a little concerning b/c they are hacking around the # modulepath, so these tests will not catch issues that may eventually arise # related to loading these plugins. -# I could not, for the life of me, figure out how to programatcally set the modulepath +# I could not, for the life of me, figure out how to programmatically set the modulepath $LOAD_PATH.push( File.join( File.dirname(__FILE__), diff --git a/spec/unit/puppet/provider/swift_storage_policy/ruby.rb b/spec/unit/puppet/provider/swift_storage_policy/ruby.rb index cc73d0ef..d31f1b00 100644 --- a/spec/unit/puppet/provider/swift_storage_policy/ruby.rb +++ b/spec/unit/puppet/provider/swift_storage_policy/ruby.rb @@ -120,7 +120,7 @@ default = false it 'swift_storage_policy resources should create correct items in swift.conf and pass error checking' do # Testing the complete flow/cases of creating swift_storage_policy resources here in one block. - # Spliting cases up across multiple "it" blocks doesn't appear to work well for a provider that calls + # Splitting cases up across multiple "it" blocks doesn't appear to work well for a provider that calls # flush. It appears that the testing needs to be done in one "it" block to duplicate the state puppet # would find when pre-fetching and flushing resources during a run. validate_file(swift_conf_no_policy, provider0.class.get_swift_conf_file) diff --git a/templates/swift_keystone_test.erb b/templates/swift_keystone_test.erb index 5194c102..377f5890 100644 --- a/templates/swift_keystone_test.erb +++ b/templates/swift_keystone_test.erb @@ -17,7 +17,7 @@ password='<%= @password %>' #password_header="-H 'X-Storage-Pass: #{password}'" #get_cred_command="curl -k -v #{user_header} #{password_header} http://#{proxy_local_net_ip}:5000/v2.0/" # -## verify that we can retrive credentials from our user +## verify that we can retrieve credentials from our user #result_hash = {} #puts "getting credentials: #{get_cred_command}" #Open3.popen3(get_cred_command) do |stdin, stdout, stderr|