Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/voxpupuli/puppet-wget

A puppet recipe for wget, a useful tool to download arbitary files from the web
https://github.com/voxpupuli/puppet-wget

bsd-puppet-module centos-puppet-module debian-puppet-module freebsd-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet redhat-puppet-module scientific-puppet-module sles-puppet-module ubuntu-puppet-module windows-puppet-module

Last synced: 3 months ago
JSON representation

A puppet recipe for wget, a useful tool to download arbitary files from the web

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/voxpupuli/puppet-wget.svg?branch=master)](https://travis-ci.org/voxpupuli/puppet-wget)

[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/wget.svg)](https://forge.puppetlabs.com/puppet/wget)

[![Puppet Forge](https://img.shields.io/puppetforge/f/puppet/wget.svg)](https://forge.puppetlabs.com/puppet/wget)

[![Puppet Forge](https://img.shields.io/puppetforge/e/puppet/wget.svg)](https://forge.puppetlabs.com/puppet/wget)



This module is declared as deprecated by Vox Pupuli.



The module [puppet-archive](https://github.com/voxpupuli/puppet-archive) is suggested as its replacement.



A Puppet module to download files with wget, supporting authentication.

It got migrated from [maestrodev](https://forge.puppet.com/maestrodev/wget) to [Vox Pupuli](https://voxpupuli.org/)



### ToC



* [Example](#example)

* [Building](#building)

* [License](#license)



---



## Example



install wget:



```puppet

    include wget

```



```puppet

    wget::fetch { "download Google's index":

      source      => 'http://www.google.com/index.html',

      destination => '/tmp/',

      timeout     => 0,

      verbose     => false,

    }

```

or alternatively:



```puppet

    wget::fetch { 'http://www.google.com/index.html':

      destination => '/tmp/',

      timeout     => 0,

      verbose     => false,

    }

```



If `$destination` ends in either a forward or backward slash, it will treat the destination as a directory and name the file with the basename of the `$source`.

```puppet

  wget::fetch { 'http://mywebsite.com/apples':

    destination => '/downloads/',

  }

```



Download from an array of URLs into one directory

```puppet

  $manyfiles = [

    'http://mywebsite.com/apples',

    'http://mywebsite.com/oranges',

    'http://mywebsite.com/bananas',

  ]



  wget::fetch { $manyfiles:

    destination => '/downloads/',

  }

```



This fetches a document which requires authentication:



```puppet

    wget::fetch { 'Fetch secret PDF':

      source      => 'https://confidential.example.com/secret.pdf',

      destination => '/tmp/',

      user        => 'user',

      password    => 'p$ssw0rd',

      timeout     => 0,

      verbose     => false,

    }

```



This caches the downloaded file in an intermediate directory to avoid

repeatedly downloading it. This uses the timestamping (-N) and prefix (-P)

wget options to only re-download if the source file has been updated.



```puppet

    wget::fetch { 'https://tool.com/downloads/tool-1.0.tgz':

      destination => '/tmp/',

      cache_dir   => '/var/cache/wget',

    }

```



It's assumed that the cached file will be named after the source's URL

basename but this assumption can be broken if wget follows some redirects. In

this case you must inform the correct filename in the cache like this:



```puppet

    wget::fetch { 'https://tool.com/downloads/tool-latest.tgz':

      destination => '/tmp/tool-1.0.tgz',

      cache_dir   => '/var/cache/wget',

      cache_file  => 'tool-1.1.tgz',

      execuser    => 'fileowner',

      group       => 'filegroup',

    }

```



Checksum can be used in the `source_hash` parameter, with the MD5-sum of the content to be downloaded.

If content exists, but does not match it is removed before downloading.



If you want to use your own unless condition, you can do it. This example uses wget to download the latest version of Wordpress to your destination folder only if the folder is empty (test used returns 1 if directory is empty or 0 if not).

```puppet

    wget::fetch { 'wordpress':

        source      => 'https://wordpress.org/latest.tar.gz',

        destination => "/var/www/html/latest_wordpress.tar.gz",

        timeout     => 0,

        unless      => "test $(ls -A /var/www/html 2>/dev/null)",

    }

```



# Building



Testing is done with rspec, [Beaker-rspec](https://github.com/puppetlabs/beaker-rspec), [Beaker](https://github.com/puppetlabs/beaker))



To test and build the module



    bundle install

    # run specs

    rake



    # run Beaker system tests with vagrant vms

    rake beaker

    # to use other vm from the list spec/acceptance/nodesets and not destroy the vm after the tests

    BEAKER_destroy=no BEAKER_set=centos-65-x64-docker bundle exec rake beaker



    # Release the Puppet module to the Forge, doing a clean, build, tag, push, bump_commit and git push

    rake module:release



# License



Copyright 2011-2013 MaestroDev



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



   http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.