openstack/swift - swift - OpenDev: Free Software Needs Free Tools

The tags framework has been discontinued for a long time; see
https://governance.openstack.org/tc/reference/tags/ and
https://governance.openstack.org/tc/resolutions/20211224-tags-framework-removal.html
Related-Change: I78815177dba9d765587d9a0aee4e0f76e14a043e
Change-Id: Ifec53e00b760a7c3ee82b7ef3d54b8f856c55aba

Change-Id: Ibd111773a496e8e3b1fc1577f40aa69f4328139b

The OpenStack project is currently maintained on opendev.org, with github.com serving as a mirror repository.
Replace the source code repository address for the python-swiftclient project from github.com to opendev.org.
Change-Id: I650a80cb45febc457c42360061faf3a9799e6131

See http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022718.html
and http://lists.opendev.org/pipermail/service-discuss/2021-May/000249.html
for more information.
Change-Id: I6ac37c23153c5c9d42d96e448e0656dbf8257991

Now that we are using gitea the contents of our README.rst are
more prominently displayed. Starting it with a "Team and repository
tags" title is a bit confusing. This change makes it start with the
name of the project instead.
Change-Id: Iaf6c162b26a32d16a083aa721aa084807af8cd60

The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that the Swift API lives at /object-store and not /object-storage.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: Ie38357e4c278335c35d186708573bb6bdabaa012

Change-Id: Ifd2f468ad745d19ef474ae7503a8bd79d429fc1b

Change-Id: If6441d61ee0cb11641c38d46763db6244e05e275

We already link to Swift's docs in particular (as opposed to OpenStack's
in general) later in the README, may as well do it earlier, too.
Change-Id: Ib11bfb551e44ccc6bbbad9d78e1e20d6486a3103

Dependencies must be installed before the docs
can successfully be built with sphinx.
Change-Id: Idd896408ecf6d9afd37ae5701cdbc224b029fd2f

New command is:
sphinx-build -W -b html doc/source doc/build/html
Change-Id: I185ae7d69093660ab558cf866ae36e45bf213975

Change the outdated links to the latest links in README
Change-Id: Ic68cc654722d47d761b308381f2ab489f3d13703

Change-Id: If347476e3b9185921ff174d3f8170a1c4d0622e8

Use https instead of http for some links in readme.rst
Change-Id: Idd382f58108e96129c69c6dc149c694fd7833fb3

Currently, our integrity checking for objects is pretty weak when it
comes to object metadata. If the extended attributes on a .data or
.meta file get corrupted in such a way that we can still unpickle it,
we don't have anything that detects that.
This could be especially bad with encrypted etags; if the encrypted
etag (X-Object-Sysmeta-Crypto-Etag or whatever it is) gets some bits
flipped, then we'll cheerfully decrypt the cipherjunk into plainjunk,
then send it to the client. Net effect is that the client sees a GET
response with an ETag that doesn't match the MD5 of the object *and*
Swift has no way of detecting and quarantining this object.
Note that, with an unencrypted object, if the ETag metadatum gets
mangled, then the object will be quarantined by the object server or
auditor, whichever notices first.
As part of this commit, I also ripped out some mocking of
getxattr/setxattr in tests. It appears to be there to allow unit tests
to run on systems where /tmp doesn't support xattrs. However, since
the mock is keyed off of inode number and inode numbers get re-used,
there's lots of leakage between different test runs. On a real FS,
unlinking a file and then creating a new one of the same name will
also reset the xattrs; this isn't the case with the mock.
The mock was pretty old; Ubuntu 12.04 and up all support xattrs in
/tmp, and recent Red Hat / CentOS releases do too. The xattr mock was
added in 2011; maybe it was to support Ubuntu Lucid Lynx?
Bonus: now you can pause a test with the debugger, inspect its files
in /tmp, and actually see the xattrs along with the data.
Since this patch now uses a real filesystem for testing filesystem
operations, tests are skipped if the underlying filesystem does not
support setting xattrs (eg tmpfs or more than 4k of xattrs on ext4).
References to "/tmp" have been replaced with calls to
tempfile.gettempdir(). This will allow setting the TMPDIR envvar in
test setup and getting an XFS filesystem instead of ext4 or tmpfs.
THIS PATCH SIGNIFICANTLY CHANGES TESTING ENVIRONMENTS
With this patch, every test environment will require TMPDIR to be
using a filesystem that supports at least 4k of extended attributes.
Neither ext4 nor tempfs support this. XFS is recommended.
So why all the SkipTests? Why not simply raise an error? We still need
the tests to run on the base image for OpenStack's CI system. Since
we were previously mocking out xattr, there wasn't a problem, but we
also weren't actually testing anything. This patch adds functionality
to validate xattr data, so we need to drop the mock.
`test.unit.skip_if_no_xattrs()` is also imported into `test.functional`
so that functional tests can import it from the functional test
namespace.
The related OpenStack CI infrastructure changes are made in
https://review.openstack.org/#/c/394600/.
Co-Authored-By: John Dickinson <me@not.mn>
Change-Id: I98a37c0d451f4960b7a12f648e4405c6c6716808

Update the doc link brought by the doc migration.
Although we had some effort to fix these, it still left lots of bad
doc link, I separate these changes into 3 patches aim to fix all of
these, this is the 2st patch for doc/manpages.
Change-Id: Id426c5dd45a812ef801042834c93701bb6e63a05

Correct documentation link address in README.
Change-Id: I1f6ac13eebf05e5deb7fe07ae7a202e1dd4e544a

It looks funny otherwise.
Change-Id: Ib00872e050a2885e43085f907780bc9ff0d2b381

Use https instead of http to ensure the safety
Change-Id: Ifdce2d0fde8ccd758cf3290cdf82faef244c8004

This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.
For more information about this effort, please read this email thread:
http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html
To see an example of how this would look like check:
https://gist.github.com/185b807657793d710f29d87ea7ec3e56
Change-Id: I78815177dba9d765587d9a0aee4e0f76e14a043e

Escaping the underscore is not necessary in this case. See
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules
Change-Id: I21d95d6baaf471246eb8a931c7df366634529512

There is a broken link to CONTRIBUTING.rst
introduced in commit a829bd5977
Change-Id: Iaedf5ff3995229cf292202793809080f9f2c7fed

This started as a new "new_contributor" doc. But we've already got
at least 3 different docs like that.
Change-Id: Ia2303ab55eeea01cc71acbccaeab55dad0ef5ff9

Change-Id: I223890bd4ffe469becc2127f9362243cdb52bc08
Closes-Bug: #1567026