-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
307 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # @summary S3 confguration for Rclone. | ||
| # | ||
| # Ensures S3 Rclone configuration of given name and params. Include of `rclone` is required. | ||
| # Currently only AWS provider is supported. | ||
| # | ||
| # @example | ||
| # rclone::config::s3 { 's3_remote': | ||
| # os_user => 'my_user', | ||
| # access_key_id => 'SOME_ACCESS_KEY', | ||
| # secret_access_key => 'SECRET_ACCESS_KEY', | ||
| # region => 'us-east-1', | ||
| # } | ||
| # | ||
| # @param ensure | ||
| # configuration ensure | ||
| # @param os_user | ||
| # operating system user - used to execute rclone commands, effective configuration owner | ||
| # @param config_name | ||
| # configuration name - should be unique among Rclone configurations, defaults to title | ||
| # @param access_key_id | ||
| # S3 provider's access_key_id, maps to Rclone `access_key_id` property | ||
| # @param secret_access_key | ||
| # S3 provider's secret_access_key, maps to Rclone `secret_access_key` property | ||
| # @param region | ||
| # S3 provider's region, maps to Rclone `region` property | ||
| # @param s3_provider | ||
| # S3 provider, maps to Rclone `provider` property | ||
| # @param canned_acl | ||
| # S3 canned ACL, maps to Rclone `acl` property | ||
| # @param endpoint | ||
| # S3 provider's endpoint, maps to Rclone `endpoint` property | ||
| # @param location_constraint | ||
| # S3 location_constraint, maps to Rclone `location_constraint` property | ||
| # @param location_constraint | ||
| # S3 location_constraint, maps to Rclone `location_constraint` property | ||
| # @param server_side_encryption | ||
| # S3 server_side_encryption, maps to Rclone `server_side_encryption` property | ||
| # @param storage_class | ||
| # S3 storage_class, maps to Rclone `storage_class` property | ||
| define rclone::config::s3 ( | ||
| String $os_user, | ||
| String $access_key_id, | ||
| String $secret_access_key, | ||
| String $region, | ||
| Enum['present', 'absent'] $ensure = 'present', | ||
| String $config_name = $title, | ||
| Enum['AWS'] $s3_provider = 'AWS', | ||
| Optional[String] $canned_acl = undef, | ||
| Optional[String] $endpoint = undef, | ||
| Optional[String] $location_constraint = undef, | ||
| Optional[String] $server_side_encryption = undef, | ||
| Optional[String] $storage_class = undef, | ||
| ) { | ||
|
|
||
| if ! defined(Class[rclone]) { | ||
| fail('You must include the rclone base class before using any defined resources') | ||
| } | ||
|
|
||
| $_rclone_exec_defaults = { | ||
| user => $os_user, | ||
| path => '/usr/bin', | ||
| require => Class[rclone], | ||
| } | ||
|
|
||
| case $ensure { | ||
| 'present': { | ||
|
|
||
| $_options = { | ||
| acl => $canned_acl, | ||
| endpoint => $endpoint, | ||
| location_constraint => $location_constraint, | ||
| server_side_encryption => $server_side_encryption, | ||
| storage_class => $storage_class, | ||
| } | ||
| .filter |$key, $val| { $val != undef }.map |$key, $val| { "${key} ${val}" }.join(' ') | ||
|
|
||
| exec { default: *=> $_rclone_exec_defaults; "rclone create remote ${config_name} for user ${os_user}": | ||
| command => @("CMD") | ||
| rclone config create ${config_name} s3 \ | ||
| provider ${s3_provider} env_auth false access_key_id ${access_key_id} secret_access_key ${secret_access_key} region ${region} \ | ||
| ${_options} | ||
| | CMD | ||
| } | ||
| } | ||
|
|
||
| 'absent': { | ||
| exec { default: *=> $_rclone_exec_defaults; "rclone delete remote ${config_name} for user ${os_user}": | ||
| command => "rclone config delete ${config_name}", | ||
| } | ||
| } | ||
|
|
||
| default: { | ||
| fail("Invalid ensure value '${ensure}'") | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| require 'spec_helper' | ||
|
|
||
| describe 'rclone::config::s3' do | ||
| let(:title) { 'test_r' } | ||
| let(:params) do | ||
| { | ||
| os_user: 'user', | ||
| access_key_id: 'aws_id', | ||
| secret_access_key: 'aws_key', | ||
| region: 'eu-west-1', | ||
| } | ||
| end | ||
|
|
||
| context 'on missing rclone main class' do | ||
| it { is_expected.to compile.and_raise_error(%r{include the rclone base class}) } | ||
| end | ||
|
|
||
| on_supported_os.each do |os, os_facts| | ||
| context "on #{os}" do | ||
| let(:facts) { os_facts } | ||
| let(:pre_condition) { 'include rclone' } | ||
|
|
||
| it { is_expected.to compile } | ||
|
|
||
| it { | ||
| is_expected.to contain_exec('rclone create remote test_r for user user') | ||
| .with( | ||
| command: 'rclone config create test_r s3 \\' \ | ||
| "\nprovider AWS env_auth false access_key_id aws_id secret_access_key aws_key region eu-west-1 \\\n\n", | ||
| user: 'user', | ||
| path: '/usr/bin', | ||
| ) | ||
| .that_requires('Class[rclone]') | ||
| } | ||
|
|
||
| context 'with optional params' do | ||
| let(:params) do | ||
| super().merge( | ||
| canned_acl: 'private', | ||
| endpoint: 'some-s3.com', | ||
| location_constraint: 'eu-west-1', | ||
| server_side_encryption: 'AES256', | ||
| storage_class: 'STANDARD', | ||
| ) | ||
| end | ||
|
|
||
| it { | ||
| is_expected.to contain_exec('rclone create remote test_r for user user') | ||
| .with( | ||
| command: 'rclone config create test_r s3 \\' \ | ||
| "\nprovider AWS env_auth false access_key_id aws_id secret_access_key aws_key region eu-west-1 \\" \ | ||
| "\nacl private endpoint some-s3.com location_constraint eu-west-1 server_side_encryption AES256 storage_class STANDARD\n", | ||
| user: 'user', | ||
| path: '/usr/bin', | ||
| ) | ||
| .that_requires('Class[rclone]') | ||
| } | ||
| end | ||
|
|
||
| context 'with ensure => absent' do | ||
| let(:params) do | ||
| super().merge(ensure: 'absent') | ||
| end | ||
|
|
||
| it { | ||
| is_expected.to contain_exec('rclone delete remote test_r for user user') | ||
| .with( | ||
| command: 'rclone config delete test_r', | ||
| user: 'user', | ||
| path: '/usr/bin', | ||
| ) | ||
| .that_requires('Class[rclone]') | ||
| } | ||
| end | ||
| end | ||
| end | ||
| end |