TransRead: provide user-friendly error message for pbzip2

If the bz2 file is a multi-stream archive and the 'bz2file' library was not
found, we cannot read the file and just fail with a scary traceback. This patch
adds a nice user-friendly message which suggests what to do in this case.

Change-Id: I41971a58fbe9712162b3ffb294c6f5e0272f34b9
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: add pbzip2 support

This patch adds support for multi-stream bz2 files (creted with pbzip2).
Unfortunately, the standard python 2.7 'bz2' module does not support it, so we
use the 'bz2file' module from PyPI.

'bz2file' may not be present in the system, in which case we fall-back to the
standard python 2.7 'bz2' module. As a bonus, 'bz2file' is a little bit faster
than 'bz2' even for single-stream archives.

Change-Id: I7b473987a3bda0241f49da5bbdf1a8a2b3841400
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: remove useless check

The _CompressedFile class is designed to work with compressed files, and it
makes no sense to use it for uncompress files. So let's assume that the
decompression function is always present and remove the useless
"if self._decompress_func" check.

Change-Id: Ie427f1507801525f29efd103dfd4cfdf76291b7e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: remove code duplication

We had some amount of duplicated code related to opening a tar file - introduce
a '_open_tarfile()' helper function for this instead.

On top of this, stop using 'tarfile' modules for opening 'tar.gz' and 'tar.bz2'
files since for some reasons this is a lot slower than using the
'_CompressedFile' module, like we do for 'tar.xz' files.

Change-Id: I1c35cff9056c555df7e7391da0b0213a016a9e45
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: assume that bmap and asc files are not compressed

Remove useless 'is_compressed' check for bmap and asc files which are never
compressed, since compression is currently detected by file extention, so .bmap
and .asc extentions always correspond to an uncompressed file.

Change-Id: I93e743bc760f0f37d6fcee8bc079eade532708f1
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: store compression type name

Introduce an 'compression_type' attribute and store the compression format
there. This will be needed in the next patches, where we will add 'pbzip2'
support. Also, remove the 'is_compressed' attribute sinc this is the same as
'compression_type == "none"'.

Change-Id: I02dfd8efb14e5868d9b413c08b14ca8f513773f8
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: catch exception from the Filemap module

The 'Filemap' module can raise exceptions in case of errors. Let's catch them
and re-raise as 'BmapCreate.Error' exceptions. This will make 'bmaptool' catch
them too and print a nice error message.

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>

RELEASE_NOTES: start release notes for v3.2

Starte preparing bmapt-tools-3.2 release notes and describe the tmpfs and
SEEK_HOLE support there.

Change-Id: Iba0b8c3d784c55dc566985983a5c44ebd9fc7f64
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: move _lseek out of the class

Pylint suggested that the 'FilemapSeek._lseek()' would better be an independent
function. Let's do this and move it out of the FilemapSeek class.

Change-Id: Ifeb582a0e1f4c719d29f8a27794649fbc61678c9
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: fix and tidy-up bmap file formatting

We generated bogus commentary for files with zero mapped block:

<!-- Count of mapped blocks: 0 bytes or 0.0%0.0    -->
        <MappedBlocksCount> 0   </MappedBlocksCount>

and this patch fixes it. On top of this, we put too many white-spaces
in the <MappedBlocksCount> because we used wrong variable to calculate
the maximum amount of spaces. Fix this as well.

Change-Id: Icf80b1b8cdba7785755890f066824bb3abb42e0a
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: add debugging facility

Add the 'log' parameter to the Filemap* classes to allow passing the logger
object where the debugging prints will go. This is similar to what we have in
the BmapCopy module. Also add the same parameter to 'BmapCreate' and make sure
that 'bmaptool' passes its logger to 'BmapCreate', which then passes it to
'Filemap*' objects, where we use it for debugging.

This makes sure that '--debug' triggers debugging messages from 'Filemap*'
ojects.

Change-Id: Idc9686edc4809856720481f79e37887d29a8b0df
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Make all classes to be of new style

Pylint nowadays prints something like this when it sees old-style classes:

C: 41, 0: Old-style class defined. (old-style-class)

Let's fix it globally by making all our classes to be of new style.

Change-Id: If9cd20bc85247a50aac140575b3e7b6d51a9a564
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: remove the SEEK_HOLE entry

because it is done.

Change-Id: I0baec33c52a6e1494280e9fabcddaf660a86f3e4
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: amend commentaries

Now we do support tmpfs, since we have the FiemapSeek class which works on
tmpfs, so correct commentaries.

Change-Id: I29f348a2f93746120112a80878379a62a13f634d
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_filemap: improve the test

The test did not cover the 'block_is_mapped()' and 'block_is_unmapped()'
methods of the Filemap module - improve this. Also, test both 'FilemapFiemap'
and 'FilemapSeek' classes.

On top of this, do not fail if the kernel of the file-system does not support
FIEMAP or SEEK_HOLE.

Change-Id: Iaa81f60e93084b5ada489b9fbbcf65568563335e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: implement ugly heuristics for SEEK_HOLE

Old kernels do not have real SEEK_HOLE support, but instead, provide a stub
implementation which just returns EOF. And there seem to be no easy way to find
out whether the implementation is real or fake. But we need to know this,
because it is crucial for use since we won't get the block map with fake
SEEK_HOLE implementation.

This patch implements an ugly test which appends a hole to the image file,
tests whether SEEK_HOLE is fake or not, and then truncats the image file back
to the original size.

Change-Id: Ib5744d5247aa0cda02517afe7189059cc5efeb9b
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: distinguish the "not supported" error

Introduce a new exception type (ErrorNotSupp) in order to distinguish the
situation when FIEMAP or SEEK_HOLE is not supported by the system.

Change-Id: I61a8ec24a1f88d5adccbc449eb3ac2d2fd80163b
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: implement the FilemapSeek class

Change-Id: Idf8bf086ead16affede86a1839f29536b8e90bbd
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: introduce a FilemapSeek class

This patch introduce a so far dummy FilemapSeek class which sill be an
alternative to FilemapFiemap. It also introduces the 'Filemap' function which
automatically selects which class will be used for getting block map. The
FIEMAP method is preferred as it is supposedly faster (at least for large
enough files).

This patch also converts all places where we creant an instance of 'Fiemap'
class to use the 'Filemap' function.

Change-Id: Ic0fcb060b5262e0314582ef3b6dc5f464e4c39a5
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: introduce base class

We are going to introduce another class which uses the 'SEEK_HOLE' mechanism
for getting file block map, and some of the 'class Fiemap' functionality is
going to be the same in both. Let's separate that common functionality into a
separate '_FilemapBase' class which other classes will inherit.

The '_FilemapBase' class also defines the methods child classes have to
implement and documents them.

Change-Id: Ie1e05f96c1d8d9c77913b613940dc7e2e7971359
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: simplify the FIEMAP failure error path

Simplify the FIEMAP ioctl error handling by removing the 'looks like your
kernel does not support FIEMAP' note. I've recently got a bug report from the
field where people hit this error, and that line not was not actually appended
to the error message because the error code was something like ENOTSUPP. And
the error was anyway very clear and readable.

So let's just remove that part and simplify the code.

Change-Id: Ib098c814d70980bdcb60402eafd213c08f8c9dbd
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Filemap: remove useless constants and a parameter

This patch simplifies the Fiemap class API and removes the 'buf_size'
constructor parameter because it is useless. The default 256K value is good
enough. Remove a couple of related constants along with this for the same
reason.

Change-Id: I6d9bbca7f54ae409ad6e83b21b35a5e84504f847
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Rename Fiemap.py to Filemap.py

The FIEMAP ioctl is not supported by tmpfs, so currently bmaptool fails to
create the bmap file when the file resides on tmpfs. This is unfortunate.

However, tmpfs supports 'SEEK_HOLE' which we can use instead of FIEMAP.

This patch is a preparation for adding 'SEEK_HOLE' support. Namely, we re-name
the Fiemap.py module to Filemap.py, where we'll support both FIEMAP and
SEEK_HOLE. Variables which contain 'fiemap' are also re-named so that they now
contain 'filemap' instead.

Change-Id: I20eac7adbdc3ad6d39c8ce5b67a5cbdbdf2987be
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Update TODO list

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>

make_a_release: remove TODOs

One is done, the other one is not needed so far, so let's kill that. Also, we
have a separate TODO file which should be used instead.

Change-Id: Ia2b07f2fd00a40ba4e3964113c8cca3b4b48937c
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

make_a_release: do not forget to push the devel branch out

The script assumes that the devel branch is pushed out, but this is not
necessarily the case. Teach 'make_a_release' script reminding about pushing the
devel branch too.

Change-Id: I6a0118ff886800f59700b18d13cda3a47d4cf8ad
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Release version 3.1

Change-Id: I0987e7a7ebf9cd82b883766c95e3132438d5757e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

docs: update the README file

Change-Id: I1ddec192e3bd2c1de88665991af920cb2294cfa7
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

docs: add v3.1 release notes
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
Change-Id: I7b1e57731f91ca4ebb6e16dace1559dde1461726

TODO: add another entry

Change-Id: I7adff60bc9828110a82531c00969dc38c52cb42c
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Silence all uninteresting pylint recommendations

Pylint produces many recommendations, but sometimes they are not very
interesting and I am not planning to change the code to fulfill them. For all
such cases, let's silence them. There are also a couple of false-positive
warnings like 'unable to import backports', silence them too.

Change-Id: Iac0a778877a6a71b9f28465d10c77b902a6b474e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests/oldcodebase: disable all pylint warnings

This is old code, and we are not goint to fix any warnings there, and we are
not going to modify these files, so let's just silence pylint for these old
files.

Change-Id: Ic9b1fd648751115400c477a883eebd58425c4658
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

make_a_release: remind about updating the compat test

Change-Id: I06d0bdea86c391ffc5cba8ff862a791b8d3f678d
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: remove the complete items

Change-Id: I56e94874e871ece9454359be15bb91c7ec203a02
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_compat: improve backward compatibility test

Currently 'test_compat' verifies that BmapCopy handles all the older bmap file
formats. This patch adds a check that older BmapCopy implementations are able
to handle all the compatible bmap file formats.

The reason for this test is that I once screwed it up with version 1.4: it had
incompatible changes, and older versions of BmapCopy crash with 1.4. If I had
this test-suite, I would add the new bmap format file to 'tests/test-data', and
the mistake would be caought right away.

Change-Id: I62ac407fb9cfe3b7158853ce09d5402cf85785de
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: add old code-base

I am going to add a test which verifies that older BmapCopy work fine with
newer compatible bmap formats, as well as newer BmapCopy works fine with all
the older bmap formats.

This patch simply add a copy of various BmapCopy versions.

Change-Id: I37941f343b56511a85a47cda239dd702b7d2afc0
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: update the todo list

Change-Id: Iae87d0a54aab6425dc35e30f18a01ffa1e7ca59c
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_compat: new test for checking backward-compatibility

This test makes sure that BmapCopy works fine with all the previous bmap file
formats.

Change-Id: Ia3da88a99b32497f8ca782630d698ca54cfafc09
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: add test data

Add a randomly-generated test image and bmap files of different formats. The
intention is to add a test case which verifies backward-compatibility.

Change-Id: I4cfbb5b16b252bbde3292aabcc7b432c3ee23e9e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: move a couple of functions to helpers.py

Move '_copy_and_verify_image()' and  '_calculate_chksum()' to the helpers.py
file since I am going to use them in the new unit test which I am about to add.
Remove the leading underscore since these functions become usable from outside.
Move some necessary module imports to helpers.py too.

Change-Id: Ifca399497f2d7b7bf046f916c1e744a4422cc7cc
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: rename _copy_image

This function copies and verifies, so let's call it '_copy_and_verify_image()'.

Change-Id: Ifd67af5a3eee73dc755097462410bcc1835a145c
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use file name in _copy_image (3)

This is a minor clean-up which changes the '_copy_image()' so that it expects
the bmap file to be a path and does not allow for file-like objects. This is
cleaner than seeking the file-like object in this function, which changes the
object state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: I9929a4bbbc496156db9e0fb821f998bcf7279904
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use file name in _copy_image (2)

This is a minor clean-up which changes the '_copy_image()' so that it expects
the image to be a path and does not allow for file-like objects. This is
cleaner than seeking the file-like object in this function, which changes the
object state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: I4a74431d10e2c174c4e21dd11a8adc69603a717f
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use file name in _do_test

This is a minor clean-up which changes the '_do_test()' so that it expects the
image to be a path and does not allow for file-like objects. This is cleaner
than seeking the file-like object in this function, which changes the object
state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: I884b54db2875bfbe68b15172ccc26767c40ff971
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use file name in _generate_compressed_files

This is a minor clean-up which changes the '_generate_compressed_files()' so
that it expects the image to be a path and does not allow for file-like
objects. This is cleaner than seeking the file-like object in this function,
which changes the object state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: I2c9004fa66b50a73d310f5ab649e3c1b1a3835c1
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use file name in _calculate_chksum

This is a minor clean-up which changes the '_calculate_chksum()' so that it
expects the image to be a path and does not allow for file-like objects. This
is cleaner than seeking the file-like object in this function, which changes
the object state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: Iec472bd5f02eb9c2a1162f43fb41defe87ff3ed6
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use image name in _copy_image

This is a minor clean-up which changes the '_copy_image()' so that it expects
the image to be a path and does not allow for file-like objects. This is
cleaner than seeking the file-like object in this function, which changes the
object state.

This change is rather mechanical, and this is actually a preparation for the
upcoming changes, where I am going to make '_copy_image()' and some other
function generic, and then use them in a new test which I am going to add.

Change-Id: I81e7e2d15676794f9d5e0e93ce62e0945b95a6d0
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: add proper license header to all tests

Change-Id: I95195b227301119486c967cea2a338391ff26123
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: handle bmap format version 2.0

This patch makes BmapCopy handle bmap format version 2.0, which is identical to
format 1.4. Format 1.4 was released by a mistake. Format 1.4 makes bmaptool
v2.x crash because it has incompatible changes. This is unfurtunate, sorry for
this.

Change-Id: Id26fd9fc807474004dddef0eee0b2028f75c3c41
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: fix bmap file format version

By a mistake, I've made bmap file format version to be 1.4, while is should
really have been 2.0, because there were incompatible changes. Fix this.

Change-Id: If2618db2c12b82f64e1f813e72a2786efdf4d3d5
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: verify versions in a single function

This patch is a minor clean-up and a preparation to the upcoming changes. It
makes sure that all the differences between various bmap format version are
handled in the '_parse_bmap()' method, and we do not have to worry about the
format differences later on.

Change-Id: I00b0cc7b5f9c3372f85fb7519c3ce768f5db3bf4
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: add some more entries

Change-Id: Ief83f6e42a306946826f89794c64981f0450baf3
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Release version 3.0

Change-Id: I7dbcefaf07eff13f1aca05a3fa30a135989acae9
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: warn if destination file is suspecious

Warn a user if he/she writes to a file under /dev, but it is not a special
device file, but just a regular file. This should improve user-friendliness.

Change-Id: I70e49d1c34ade667008dc606eb555e924b864ade
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: make sha256 to be the default

Change-Id: I9d788371cfcc8a6c45ac7c443421c757058a12c6
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: add a couple of debug messages

Add a couple of useful debug messages to BmapCopy.

Also, do not print the progress indicator when debugging is on.

Change-Id: I38aca82e3f7f9704f827f72e6d702b0c65d26b24
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: rename _logger to _log

This patch renames the _logger class attribute to "_log". The reason is to make
logging statements shorter. Besides, we use "log" in bmaptool, so this also
brings a bit more consistency.

Do the same change also in TransRead.

Change-Id: I72ce6070bb792b99349ea3bd9a229cb5f7b1ca49
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: prefix debug messages with time-stamp

This patch makes the debug messages to be prefixed with time-stamp, as well as
the module name and line number. The time-stamp is highlighted with green
color.

This patch introduces a custom formatter class in order to be able to format
debug and other loglevls differently.

Change-Id: I8ed40957ced9cdcd20ee7e94a6c92ce62671a5cc
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: increase the batch queue length

BmapCopy reads and writes from different threads to exploit parallelizm. There
is a "batch queue" where the reader supply 1MiB buffers and the writer consumes
them. The length of the queue is 6 for block devices and 2 for files. This
patch makes it to be 6 everywhere since 2 is rather short.

Change-Id: Ia4c6293ad2433fd7b466733ff9fbe5a0bd288d13
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: introduce --debug option

We often need to print debugging information, let's add a --debug option for
this.

Change-Id: I038e2163d2d5929b4bd07416547936fc34bf09c2
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: fix --nobmap case

One of the previous commits introduced the NamedFile class and broke the
--nobmap case, because we created a NamedFile object even when f_bmap was None.
This patch fixes the problem.

Change-Id: I4592e06b1385dcf5d34b42717b0374c68d0c223f
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: print warning messages even with --quiet

When the --quiet option is used, we print only error messages, and warnings
are suppressed. However, it is a good idea to print warnings even with --quiet,
since they usually tell about problems users should better know about.

Change-Id: Id0f708723cc13d57191fd540e684ca0cf20a45f7
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: remove junk argument

This patch remove unneeded junk argument from the BmapBdevCopy constructor
invocation and fixes this issue:

Traceback (most recent call last):
  File "./bmaptool", line 684, in <module>
    sys.exit(main())
  File "./bmaptool", line 668, in main
    args.func(args, log)
  File "./bmaptool", line 434, in copy_command
    image_size, logger=log)
TypeError: __init__() got multiple values for keyword argument 'logger'

Change-Id: Ic77418ec81f6c085118807eb4a675034979a8f72
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: correct bad English one of the messages

Change-Id: Ib309a0dceac128410a6cb4e565c3cd556ed61b9b
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

make_a_release.sh: misc little changes

Require that the release is made in the devel branch. Amend the instructions
that we print. Remove trailing white-spaces from the changelog.

Change-Id: Ic955edafcd78b5e54d82d39f29fa00aad2c6aac6
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

RELEASE_NOTES: add 3.0 release notes

Change-Id: Ib2141049e4684c907a70e650672aac6625942c27
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: support .gizp extension

We support GnuZip files, but only look at the .gz extension, and forget about
.gzip extension. This patch fixes the situation.

Change-Id: Id5775a84fe1d0dfba87333e9f430c4931324c7e9
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: do not mark the entry point as static

Remove the @staticmethod decorator, because old unittest module on Centos6 does
not recognize static entry points and does not execute tests.

Change-Id: I6d490396fb79a9b43bc7d39328b1e5eacff0446b
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

tests: add a Centos 6 work-around

Centos 6 is very old, and it has old unittest library, and the newer one which
we need is called 'unittest2' there. This patch adds the corresponding
work-around to make our tests pass in Centos 6.

Change-Id: Ibf9d9185f23a79aeb2f0ecf67f8f22e1840f1a82
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

packaging: add missing dependencies

Change-Id: Ib8b000434b5670d418ab58b18bfff82581e4e892
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: don't parse URL twice in case of ssh proto

_open_url() method already parses the URL. Let's use it instead of doing
parsing second time.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

make_a_release.sh: various improvements

This patch makes several improvements in the make_a_release.sh.

* Ask the maintainer tough questions about whether the docs were updated
* Automatically update the RPM and Debian changelog files
* Automatically increase version number in various places

Change-Id: I17a20132c79ac0d07cdb5addddb2e9da071bb281
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: remove a dot in bmap file comment

To be consistent with other commentaries, lets not put the dot at the end of
the one-line comment.

Change-Id: I86297b87752cf38056fc37ac5dfa893e73d97051
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: update the file to reflect the current state

Change-Id: I6310ea6436d010a29ef514e276a3c56e56412993
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: improve XML parsing error message

When BmapCopy fails to parse the XML file, it prints something like this:

bmaptool: ERROR: cannot parse the bmap file '/home/dedekind/tmp/Fedora-19-i386-CHECKSUM' which should be a proper XML file: not well-formed (invalid token): line 1, column 1

(yes, I deliberately fed bmaptool a bogus file)

The problem is that sometimes we actually modify the bmap file a bit before
parsing. For example, we do this when the bmap file is signed with a clearsign
OpenPGP signature.

This means that the line number does not match the file name we print. This
patch improves the situation by providing the bogus line number and a bit of
the context in the exception error message.

Change-Id: I62b8aefde4a3ea524f528b83c4b6e70fa469e387
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: override bmap path

Sometimes we create temporary files for the bmap file object, and the 'name'
attribute of the object contains the temporary file path in these cases. Then
we pass the bmap file object to, say, BmapCreate module, which uses the 'name'
attribute in various error messages. This, for example, leads to the following
confusing error message:

bmaptool: ERROR: cannot parse the bmap file '/tmp/tmpUkoTxA' which should be a proper XML file

It is a lot nicer to print the original path instead of the temporary path.
Let's do this with help of the 'NamedFile' class that we have. It helps
substituting the 'name' attribute with something we want the user to see.

Change-Id: I0503a1014d159b3bc6da8e00b16a4d194c2f68f3
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

docs: update bmaptool's man pages

Add information about new options, and more.

Change-Id: Id1c9ffe97bbb22ebd2ee4dd645142a8bc7b6a476
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

setup.py: automatically detect version number

We currently duplicate the project version number in bmaptool and setup.py
files. Let's get rid of the duplication and have setup.py parse the bmaptool
file and fetch the version number.

Change-Id: I06ee68ca29b16fac2cbfa53cd9a61329b8606409
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: remove an entry about checking zeroes

I think I will not implement this because it makes little sense. Drop the
unmapped areas anyway, why would we care checking their contents? What for?

Change-Id: I756c073ffef65715cf418a8f3f37bf35eef86218
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Fiemap: synchronize the file before invoking the ioctl

Early FIEMAP implementations had many bugs related to cached dirty data. And
this is why it is safer to synchronize the file before invoking FIEMAP for it.
Let's start using the 'FIEMAP_FLAG_SYNC' FIEMAP ioctl flag which does exactly
that.

Change-Id: I1698b88ed3978ffa632502ba72ad345ec8708ce0
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: update the list

Remove the item about GPG signatures support, add a reminder about updating the
man pages with the GPG and hash functions information.

Change-Id: Id4a0d0cb7ec907dfbebe9090d8b85ad7138e7bbf
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: implement GPG signature verification

This is a feature which was requested by the Fedora communitiy.

Both clearsign and detached GPG signatures are supported. The signature file
auto-discovery is supported (similar to bmap file auto-discovery).

More user-facing information will be added to the man page a bit later.

We add the following command-line options:
    1. --bmap-sig option for specifying the detached signature file path
    2. --no-sig-verify option for making bmaptool avoid verifying the clearsign
       signature and avoid signature file auto-discovery

Change-Id: Id64194415759abdbbe4e2f54d997f0855f67c749
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: disallow simultaneous --bmap and --nobmap

Do not allow users to use --bmap and --nobmap at the same time since it makes
no sense.

Change-Id: I69e02c1e885f7877e6b6e1dd5218bab07f1c1f24
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: cleanups

This function improves the commentaries and renames several functions. The
renames are about removing the 'copy_command_' prefix from function names,
because it is not very readable and we do not use it consistently anyway.

Change-Id: Id8030489820cb3d9b03830b7209d30a4c0452f23
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: do not fail when copying a bmap file

It is possible that the user copies the bmapfile itself using 'bmaptool copy'.
Most probably this is just by a mistake. In this case bmaptool just fails,
since it discovers the bmap file, and it does not match the "image" (where the
image is the same bmap file).

This patch teaches bmaptool to handle this case by dropping the discoverd bmap
file if its path is the same as the image path.

Change-Id: Ib48842ed6157ba364173fcd7771e1b2ba3eea9e5
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Fiemap: fix failure for zero-sized files

The Fiemap module fails for zero-sized file with these symptoms:

Traceback (most recent call last):
  File "./bmaptool", line 561, in <module>
    sys.exit(main())
  File "./bmaptool", line 545, in main
    args.func(args, log)
  File "./bmaptool", line 419, in create_command
    creator = BmapCreate.BmapCreate(args.image, output, "sha256")
  File "/mnt/bigssd/dedekind/work/tizen/git/bmap-tools/bmaptools/BmapCreate.py", line 163, in __init__
    self.fiemap = Fiemap.Fiemap(self._f_image)
  File "/mnt/bigssd/dedekind/work/tizen/git/bmap-tools/bmaptools/Fiemap.py", line 120, in __init__
    self.block_is_mapped(0)
  File "/mnt/bigssd/dedekind/work/tizen/git/bmap-tools/bmaptools/Fiemap.py", line 175, in block_is_mapped
    struct_fiemap = self._invoke_fiemap(block, 1)
  File "/mnt/bigssd/dedekind/work/tizen/git/bmap-tools/bmaptools/Fiemap.py", line 149, in _invoke_fiemap
    % (block, self.blocks_cnt))

This patch fixes the issue.

Change-Id: I3eb2c6e69c892aea2a3d41f2b9bf830907d7658e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptool: start using sha256 when creating bmap file

Switch from using SHA1 to SHA256 for the 'bmaptool create' command.

Basically, this is what the Fedora community requested, with a reference to
this:

http://csrc.nist.gov/groups/ST/hash/policy_2006.html

Change-Id: I3facbd8d5588903b1d7d28eac77d147d0390a1c4
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: remove sha256 entry

Change-Id: I5e36f03362ad3706501fbbd1c6e2dd78893b55e7
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCreate: implement arbitrary hash type support

Instead of just supporting SHA1 hash functions type, support arbitrary hash
function type. Well, actually "arbitrary" means any hash function supported by
the "hashlib" python module.

In particular, we are interested to switch from SHA1 to SHA256.

Unfortunately, this is a format change, since format version 1.3 guaranteed
that checksum is always SHA1. This is why this patch also increases the format
version to 1.4.

Change-Id: I096b47d6e4a413368d42e40ce8ebb06f612619c5
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

BmapCopy: support arbitrary checksum types

This patch makes BmapCopy support bmap format version 1.4 which allows for
and arbitrary checksum type, not only SHA1. We are, particularly, interested in
SHA256 support.

Change-Id: I9306907ac5d29b0ce524c2abcdbcafac60096958
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

test_api_base: use sha256 instead of sha1

Well, this does not matter in this case at all, but I am going to switch to
SHA256 in BmapCreate, so changing the tests just for consistency.

Change-Id: I930314a20655da88333b1d6e8e177324794c9ba5
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

bmaptools: preparations to switch to sha256

In all places where it does not matter which exactly checksum we calculate,
substitute 'sha1' with 'chksum'. This is a preparation for the further change
where we will switch from using SHA1 checksums to using SHA256 checksums.

Change-Id: I51000ad7669d1459c5d6d5e8141e0a6d74f93a56
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: remove local caching functionality

Remove the local caching functionality of the TransRead module. This
functionality does not really belong to the module, and it only makes things
more complex. It is better to either make users of TransRead to locally cache
remote files, or create a small wrapper over TransRead for these purposes.

Since currently there is only one user of this functionality, we just implement
local caching in bmaptool directly.

Change-Id: I649a5e761b9bc4b6b10d035bfd790357eaf6c373
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: add another item

Change-Id: I5cf46966858e3aa71f3cc6e55430499a9750730e
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: improve user experience

This patch solves the following problem.

1. I forgot to define the proxy.
2. I run bmaptool, it blocks, and several minutes later it fails with an error
   like "Connection timed out"

I would instead like it to tell me that something is going wrong much earlier,
why should I wait for several minutes?

This patch improves the way we open URLs. Now instead of using the default
(usually long) timeout, we first try with a short timeout, and if we cannot
open the URL, we print user a warning, and then try to open with the default
timeout. The user may press Ctrl-C once he/she sees the warning, or start
checking the connectivity.

Change-Id: Ia5f387de62574d84d914c21794f782b1b41d530f
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: accept the logger object

In order to improve user experience, I would like to print warnings when we
cannot open the URL for some time. This requires the TransRead object to accept
the logger object, or take the global one.

Change-Id: I4fc9f3d6544a2a699b6476dddf362aa127e81550
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TransRead: handle the urllib2.URLError exception

When opening an URL with urllib2, handle the URLError exceptions too.

This patch adds a new "except" statement instead of adding the exception object
to the existing array. The reason is that in the next commit we will need to
handle the urllib2.URLError exceptions a bit differently.

This patch also refactors the code a tiny bit as a preparation to the next
commit.

Change-Id: I69856aa8698b495c5a2450979db9384aad1b713a
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

TODO: add another comment

Change-Id: I8ae67484c49eefdbd0d030059a6a6a259ce8d33f
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

Release version 2.6

Change-Id: Ic0aba0b20847454b35c7dee9d50dccdbd2cf11fa
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>

make_a_release.sh: add few more reminders

Change-Id: Ifaf378a0b803a97ca3c15bb2b3adf8ffa73cdde9
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>