grim/convey

Dump govcs in here for now until i can sort out this out
redux
2021-10-18, Gary Kramlich
c1a95d79fcc5
Parents 18b916dada5e
Children 36f6e7a6b6ce
Dump govcs in here for now until i can sort out this out
18 files changed, 1826 insertions(+), 7 deletions(-)
  • +2 -3
    environment/default.go
  • +0 -1
    go.mod
  • +0 -3
    go.sum
  • +674 -0
    govcs/LICENSE
  • +37 -0
    govcs/README.md
  • +22 -0
    govcs/exec/command.go
  • +52 -0
    govcs/exec/exec.go
  • +64 -0
    govcs/exec/mock.go
  • +57 -0
    govcs/exec/mock_test.go
  • +139 -0
    govcs/git/git.go
  • +128 -0
    govcs/git/git_test.go
  • +76 -0
    govcs/govcs.go
  • +82 -0
    govcs/govcs_test.go
  • +122 -0
    govcs/hg/hg.go
  • +116 -0
    govcs/hg/hg_test.go
  • +122 -0
    govcs/svn/svn.go
  • +89 -0
    govcs/svn/svn_test.go
  • +44 -0
    govcs/vcs/vcs.go
    • --- a/environment/default.go Sat Oct 16 05:49:25 2021 -0500
    +++ b/environment/default.go Mon Oct 18 00:39:41 2021 -0500
    @@ -22,10 +22,9 @@
    "strings"
    "time"
    - "bitbucket.org/rw_grim/govcs"
    - "bitbucket.org/rw_grim/govcs/hg"
    -
    "keep.imfreedom.org/grim/convey/consts"
    + "keep.imfreedom.org/grim/convey/govcs"
    + "keep.imfreedom.org/grim/convey/govcs/hg"
    "keep.imfreedom.org/grim/convey/normalize"
    )
    --- a/go.mod Sat Oct 16 05:49:25 2021 -0500
    +++ b/go.mod Mon Oct 18 00:39:41 2021 -0500
    @@ -1,7 +1,6 @@
    module keep.imfreedom.org/grim/convey
    require (
    - bitbucket.org/rw_grim/govcs v0.0.0-20190727184842-ba0d24484add
    github.com/alecthomas/kong v0.2.17
    github.com/go-yaml/yaml v2.1.0+incompatible
    github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
    --- a/go.sum Sat Oct 16 05:49:25 2021 -0500
    +++ b/go.sum Mon Oct 18 00:39:41 2021 -0500
    @@ -1,5 +1,3 @@
    -bitbucket.org/rw_grim/govcs v0.0.0-20190727184842-ba0d24484add h1:UrZ36ILYSiSY3lfbIVA0J0/oQ9qw6tWB9XycaEPSyAM=
    -bitbucket.org/rw_grim/govcs v0.0.0-20190727184842-ba0d24484add/go.mod h1:V6eZobI0I0CV3C1piPcqutimEoUr3zeIHiWJUKLqfnE=
    github.com/alecthomas/kong v0.2.17 h1:URDISCI96MIgcIlQyoCAlhOmrSw6pZScBNkctg8r0W0=
    github.com/alecthomas/kong v0.2.17/go.mod h1:ka3VZ8GZNPXv9Ov+j4YNLkI8mTuhXyr/0ktSlqIydQQ=
    github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
    @@ -63,7 +61,6 @@
    github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
    github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
    github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
    -github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
    github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
    github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
    github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/LICENSE Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,674 @@
    + GNU GENERAL PUBLIC LICENSE
    + Version 3, 29 June 2007
    +
    + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
    + Everyone is permitted to copy and distribute verbatim copies
    + of this license document, but changing it is not allowed.
    +
    + Preamble
    +
    + The GNU General Public License is a free, copyleft license for
    +software and other kinds of works.
    +
    + The licenses for most software and other practical works are designed
    +to take away your freedom to share and change the works. By contrast,
    +the GNU General Public License is intended to guarantee your freedom to
    +share and change all versions of a program--to make sure it remains free
    +software for all its users. We, the Free Software Foundation, use the
    +GNU General Public License for most of our software; it applies also to
    +any other work released this way by its authors. You can apply it to
    +your programs, too.
    +
    + When we speak of free software, we are referring to freedom, not
    +price. Our General Public Licenses are designed to make sure that you
    +have the freedom to distribute copies of free software (and charge for
    +them if you wish), that you receive source code or can get it if you
    +want it, that you can change the software or use pieces of it in new
    +free programs, and that you know you can do these things.
    +
    + To protect your rights, we need to prevent others from denying you
    +these rights or asking you to surrender the rights. Therefore, you have
    +certain responsibilities if you distribute copies of the software, or if
    +you modify it: responsibilities to respect the freedom of others.
    +
    + For example, if you distribute copies of such a program, whether
    +gratis or for a fee, you must pass on to the recipients the same
    +freedoms that you received. You must make sure that they, too, receive
    +or can get the source code. And you must show them these terms so they
    +know their rights.
    +
    + Developers that use the GNU GPL protect your rights with two steps:
    +(1) assert copyright on the software, and (2) offer you this License
    +giving you legal permission to copy, distribute and/or modify it.
    +
    + For the developers' and authors' protection, the GPL clearly explains
    +that there is no warranty for this free software. For both users' and
    +authors' sake, the GPL requires that modified versions be marked as
    +changed, so that their problems will not be attributed erroneously to
    +authors of previous versions.
    +
    + Some devices are designed to deny users access to install or run
    +modified versions of the software inside them, although the manufacturer
    +can do so. This is fundamentally incompatible with the aim of
    +protecting users' freedom to change the software. The systematic
    +pattern of such abuse occurs in the area of products for individuals to
    +use, which is precisely where it is most unacceptable. Therefore, we
    +have designed this version of the GPL to prohibit the practice for those
    +products. If such problems arise substantially in other domains, we
    +stand ready to extend this provision to those domains in future versions
    +of the GPL, as needed to protect the freedom of users.
    +
    + Finally, every program is threatened constantly by software patents.
    +States should not allow patents to restrict development and use of
    +software on general-purpose computers, but in those that do, we wish to
    +avoid the special danger that patents applied to a free program could
    +make it effectively proprietary. To prevent this, the GPL assures that
    +patents cannot be used to render the program non-free.
    +
    + The precise terms and conditions for copying, distribution and
    +modification follow.
    +
    + TERMS AND CONDITIONS
    +
    + 0. Definitions.
    +
    + "This License" refers to version 3 of the GNU General Public License.
    +
    + "Copyright" also means copyright-like laws that apply to other kinds of
    +works, such as semiconductor masks.
    +
    + "The Program" refers to any copyrightable work licensed under this
    +License. Each licensee is addressed as "you". "Licensees" and
    +"recipients" may be individuals or organizations.
    +
    + To "modify" a work means to copy from or adapt all or part of the work
    +in a fashion requiring copyright permission, other than the making of an
    +exact copy. The resulting work is called a "modified version" of the
    +earlier work or a work "based on" the earlier work.
    +
    + A "covered work" means either the unmodified Program or a work based
    +on the Program.
    +
    + To "propagate" a work means to do anything with it that, without
    +permission, would make you directly or secondarily liable for
    +infringement under applicable copyright law, except executing it on a
    +computer or modifying a private copy. Propagation includes copying,
    +distribution (with or without modification), making available to the
    +public, and in some countries other activities as well.
    +
    + To "convey" a work means any kind of propagation that enables other
    +parties to make or receive copies. Mere interaction with a user through
    +a computer network, with no transfer of a copy, is not conveying.
    +
    + An interactive user interface displays "Appropriate Legal Notices"
    +to the extent that it includes a convenient and prominently visible
    +feature that (1) displays an appropriate copyright notice, and (2)
    +tells the user that there is no warranty for the work (except to the
    +extent that warranties are provided), that licensees may convey the
    +work under this License, and how to view a copy of this License. If
    +the interface presents a list of user commands or options, such as a
    +menu, a prominent item in the list meets this criterion.
    +
    + 1. Source Code.
    +
    + The "source code" for a work means the preferred form of the work
    +for making modifications to it. "Object code" means any non-source
    +form of a work.
    +
    + A "Standard Interface" means an interface that either is an official
    +standard defined by a recognized standards body, or, in the case of
    +interfaces specified for a particular programming language, one that
    +is widely used among developers working in that language.
    +
    + The "System Libraries" of an executable work include anything, other
    +than the work as a whole, that (a) is included in the normal form of
    +packaging a Major Component, but which is not part of that Major
    +Component, and (b) serves only to enable use of the work with that
    +Major Component, or to implement a Standard Interface for which an
    +implementation is available to the public in source code form. A
    +"Major Component", in this context, means a major essential component
    +(kernel, window system, and so on) of the specific operating system
    +(if any) on which the executable work runs, or a compiler used to
    +produce the work, or an object code interpreter used to run it.
    +
    + The "Corresponding Source" for a work in object code form means all
    +the source code needed to generate, install, and (for an executable
    +work) run the object code and to modify the work, including scripts to
    +control those activities. However, it does not include the work's
    +System Libraries, or general-purpose tools or generally available free
    +programs which are used unmodified in performing those activities but
    +which are not part of the work. For example, Corresponding Source
    +includes interface definition files associated with source files for
    +the work, and the source code for shared libraries and dynamically
    +linked subprograms that the work is specifically designed to require,
    +such as by intimate data communication or control flow between those
    +subprograms and other parts of the work.
    +
    + The Corresponding Source need not include anything that users
    +can regenerate automatically from other parts of the Corresponding
    +Source.
    +
    + The Corresponding Source for a work in source code form is that
    +same work.
    +
    + 2. Basic Permissions.
    +
    + All rights granted under this License are granted for the term of
    +copyright on the Program, and are irrevocable provided the stated
    +conditions are met. This License explicitly affirms your unlimited
    +permission to run the unmodified Program. The output from running a
    +covered work is covered by this License only if the output, given its
    +content, constitutes a covered work. This License acknowledges your
    +rights of fair use or other equivalent, as provided by copyright law.
    +
    + You may make, run and propagate covered works that you do not
    +convey, without conditions so long as your license otherwise remains
    +in force. You may convey covered works to others for the sole purpose
    +of having them make modifications exclusively for you, or provide you
    +with facilities for running those works, provided that you comply with
    +the terms of this License in conveying all material for which you do
    +not control copyright. Those thus making or running the covered works
    +for you must do so exclusively on your behalf, under your direction
    +and control, on terms that prohibit them from making any copies of
    +your copyrighted material outside their relationship with you.
    +
    + Conveying under any other circumstances is permitted solely under
    +the conditions stated below. Sublicensing is not allowed; section 10
    +makes it unnecessary.
    +
    + 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
    +
    + No covered work shall be deemed part of an effective technological
    +measure under any applicable law fulfilling obligations under article
    +11 of the WIPO copyright treaty adopted on 20 December 1996, or
    +similar laws prohibiting or restricting circumvention of such
    +measures.
    +
    + When you convey a covered work, you waive any legal power to forbid
    +circumvention of technological measures to the extent such circumvention
    +is effected by exercising rights under this License with respect to
    +the covered work, and you disclaim any intention to limit operation or
    +modification of the work as a means of enforcing, against the work's
    +users, your or third parties' legal rights to forbid circumvention of
    +technological measures.
    +
    + 4. Conveying Verbatim Copies.
    +
    + You may convey verbatim copies of the Program's source code as you
    +receive it, in any medium, provided that you conspicuously and
    +appropriately publish on each copy an appropriate copyright notice;
    +keep intact all notices stating that this License and any
    +non-permissive terms added in accord with section 7 apply to the code;
    +keep intact all notices of the absence of any warranty; and give all
    +recipients a copy of this License along with the Program.
    +
    + You may charge any price or no price for each copy that you convey,
    +and you may offer support or warranty protection for a fee.
    +
    + 5. Conveying Modified Source Versions.
    +
    + You may convey a work based on the Program, or the modifications to
    +produce it from the Program, in the form of source code under the
    +terms of section 4, provided that you also meet all of these conditions:
    +
    + a) The work must carry prominent notices stating that you modified
    + it, and giving a relevant date.
    +
    + b) The work must carry prominent notices stating that it is
    + released under this License and any conditions added under section
    + 7. This requirement modifies the requirement in section 4 to
    + "keep intact all notices".
    +
    + c) You must license the entire work, as a whole, under this
    + License to anyone who comes into possession of a copy. This
    + License will therefore apply, along with any applicable section 7
    + additional terms, to the whole of the work, and all its parts,
    + regardless of how they are packaged. This License gives no
    + permission to license the work in any other way, but it does not
    + invalidate such permission if you have separately received it.
    +
    + d) If the work has interactive user interfaces, each must display
    + Appropriate Legal Notices; however, if the Program has interactive
    + interfaces that do not display Appropriate Legal Notices, your
    + work need not make them do so.
    +
    + A compilation of a covered work with other separate and independent
    +works, which are not by their nature extensions of the covered work,
    +and which are not combined with it such as to form a larger program,
    +in or on a volume of a storage or distribution medium, is called an
    +"aggregate" if the compilation and its resulting copyright are not
    +used to limit the access or legal rights of the compilation's users
    +beyond what the individual works permit. Inclusion of a covered work
    +in an aggregate does not cause this License to apply to the other
    +parts of the aggregate.
    +
    + 6. Conveying Non-Source Forms.
    +
    + You may convey a covered work in object code form under the terms
    +of sections 4 and 5, provided that you also convey the
    +machine-readable Corresponding Source under the terms of this License,
    +in one of these ways:
    +
    + a) Convey the object code in, or embodied in, a physical product
    + (including a physical distribution medium), accompanied by the
    + Corresponding Source fixed on a durable physical medium
    + customarily used for software interchange.
    +
    + b) Convey the object code in, or embodied in, a physical product
    + (including a physical distribution medium), accompanied by a
    + written offer, valid for at least three years and valid for as
    + long as you offer spare parts or customer support for that product
    + model, to give anyone who possesses the object code either (1) a
    + copy of the Corresponding Source for all the software in the
    + product that is covered by this License, on a durable physical
    + medium customarily used for software interchange, for a price no
    + more than your reasonable cost of physically performing this
    + conveying of source, or (2) access to copy the
    + Corresponding Source from a network server at no charge.
    +
    + c) Convey individual copies of the object code with a copy of the
    + written offer to provide the Corresponding Source. This
    + alternative is allowed only occasionally and noncommercially, and
    + only if you received the object code with such an offer, in accord
    + with subsection 6b.
    +
    + d) Convey the object code by offering access from a designated
    + place (gratis or for a charge), and offer equivalent access to the
    + Corresponding Source in the same way through the same place at no
    + further charge. You need not require recipients to copy the
    + Corresponding Source along with the object code. If the place to
    + copy the object code is a network server, the Corresponding Source
    + may be on a different server (operated by you or a third party)
    + that supports equivalent copying facilities, provided you maintain
    + clear directions next to the object code saying where to find the
    + Corresponding Source. Regardless of what server hosts the
    + Corresponding Source, you remain obligated to ensure that it is
    + available for as long as needed to satisfy these requirements.
    +
    + e) Convey the object code using peer-to-peer transmission, provided
    + you inform other peers where the object code and Corresponding
    + Source of the work are being offered to the general public at no
    + charge under subsection 6d.
    +
    + A separable portion of the object code, whose source code is excluded
    +from the Corresponding Source as a System Library, need not be
    +included in conveying the object code work.
    +
    + A "User Product" is either (1) a "consumer product", which means any
    +tangible personal property which is normally used for personal, family,
    +or household purposes, or (2) anything designed or sold for incorporation
    +into a dwelling. In determining whether a product is a consumer product,
    +doubtful cases shall be resolved in favor of coverage. For a particular
    +product received by a particular user, "normally used" refers to a
    +typical or common use of that class of product, regardless of the status
    +of the particular user or of the way in which the particular user
    +actually uses, or expects or is expected to use, the product. A product
    +is a consumer product regardless of whether the product has substantial
    +commercial, industrial or non-consumer uses, unless such uses represent
    +the only significant mode of use of the product.
    +
    + "Installation Information" for a User Product means any methods,
    +procedures, authorization keys, or other information required to install
    +and execute modified versions of a covered work in that User Product from
    +a modified version of its Corresponding Source. The information must
    +suffice to ensure that the continued functioning of the modified object
    +code is in no case prevented or interfered with solely because
    +modification has been made.
    +
    + If you convey an object code work under this section in, or with, or
    +specifically for use in, a User Product, and the conveying occurs as
    +part of a transaction in which the right of possession and use of the
    +User Product is transferred to the recipient in perpetuity or for a
    +fixed term (regardless of how the transaction is characterized), the
    +Corresponding Source conveyed under this section must be accompanied
    +by the Installation Information. But this requirement does not apply
    +if neither you nor any third party retains the ability to install
    +modified object code on the User Product (for example, the work has
    +been installed in ROM).
    +
    + The requirement to provide Installation Information does not include a
    +requirement to continue to provide support service, warranty, or updates
    +for a work that has been modified or installed by the recipient, or for
    +the User Product in which it has been modified or installed. Access to a
    +network may be denied when the modification itself materially and
    +adversely affects the operation of the network or violates the rules and
    +protocols for communication across the network.
    +
    + Corresponding Source conveyed, and Installation Information provided,
    +in accord with this section must be in a format that is publicly
    +documented (and with an implementation available to the public in
    +source code form), and must require no special password or key for
    +unpacking, reading or copying.
    +
    + 7. Additional Terms.
    +
    + "Additional permissions" are terms that supplement the terms of this
    +License by making exceptions from one or more of its conditions.
    +Additional permissions that are applicable to the entire Program shall
    +be treated as though they were included in this License, to the extent
    +that they are valid under applicable law. If additional permissions
    +apply only to part of the Program, that part may be used separately
    +under those permissions, but the entire Program remains governed by
    +this License without regard to the additional permissions.
    +
    + When you convey a copy of a covered work, you may at your option
    +remove any additional permissions from that copy, or from any part of
    +it. (Additional permissions may be written to require their own
    +removal in certain cases when you modify the work.) You may place
    +additional permissions on material, added by you to a covered work,
    +for which you have or can give appropriate copyright permission.
    +
    + Notwithstanding any other provision of this License, for material you
    +add to a covered work, you may (if authorized by the copyright holders of
    +that material) supplement the terms of this License with terms:
    +
    + a) Disclaiming warranty or limiting liability differently from the
    + terms of sections 15 and 16 of this License; or
    +
    + b) Requiring preservation of specified reasonable legal notices or
    + author attributions in that material or in the Appropriate Legal
    + Notices displayed by works containing it; or
    +
    + c) Prohibiting misrepresentation of the origin of that material, or
    + requiring that modified versions of such material be marked in
    + reasonable ways as different from the original version; or
    +
    + d) Limiting the use for publicity purposes of names of licensors or
    + authors of the material; or
    +
    + e) Declining to grant rights under trademark law for use of some
    + trade names, trademarks, or service marks; or
    +
    + f) Requiring indemnification of licensors and authors of that
    + material by anyone who conveys the material (or modified versions of
    + it) with contractual assumptions of liability to the recipient, for
    + any liability that these contractual assumptions directly impose on
    + those licensors and authors.
    +
    + All other non-permissive additional terms are considered "further
    +restrictions" within the meaning of section 10. If the Program as you
    +received it, or any part of it, contains a notice stating that it is
    +governed by this License along with a term that is a further
    +restriction, you may remove that term. If a license document contains
    +a further restriction but permits relicensing or conveying under this
    +License, you may add to a covered work material governed by the terms
    +of that license document, provided that the further restriction does
    +not survive such relicensing or conveying.
    +
    + If you add terms to a covered work in accord with this section, you
    +must place, in the relevant source files, a statement of the
    +additional terms that apply to those files, or a notice indicating
    +where to find the applicable terms.
    +
    + Additional terms, permissive or non-permissive, may be stated in the
    +form of a separately written license, or stated as exceptions;
    +the above requirements apply either way.
    +
    + 8. Termination.
    +
    + You may not propagate or modify a covered work except as expressly
    +provided under this License. Any attempt otherwise to propagate or
    +modify it is void, and will automatically terminate your rights under
    +this License (including any patent licenses granted under the third
    +paragraph of section 11).
    +
    + However, if you cease all violation of this License, then your
    +license from a particular copyright holder is reinstated (a)
    +provisionally, unless and until the copyright holder explicitly and
    +finally terminates your license, and (b) permanently, if the copyright
    +holder fails to notify you of the violation by some reasonable means
    +prior to 60 days after the cessation.
    +
    + Moreover, your license from a particular copyright holder is
    +reinstated permanently if the copyright holder notifies you of the
    +violation by some reasonable means, this is the first time you have
    +received notice of violation of this License (for any work) from that
    +copyright holder, and you cure the violation prior to 30 days after
    +your receipt of the notice.
    +
    + Termination of your rights under this section does not terminate the
    +licenses of parties who have received copies or rights from you under
    +this License. If your rights have been terminated and not permanently
    +reinstated, you do not qualify to receive new licenses for the same
    +material under section 10.
    +
    + 9. Acceptance Not Required for Having Copies.
    +
    + You are not required to accept this License in order to receive or
    +run a copy of the Program. Ancillary propagation of a covered work
    +occurring solely as a consequence of using peer-to-peer transmission
    +to receive a copy likewise does not require acceptance. However,
    +nothing other than this License grants you permission to propagate or
    +modify any covered work. These actions infringe copyright if you do
    +not accept this License. Therefore, by modifying or propagating a
    +covered work, you indicate your acceptance of this License to do so.
    +
    + 10. Automatic Licensing of Downstream Recipients.
    +
    + Each time you convey a covered work, the recipient automatically
    +receives a license from the original licensors, to run, modify and
    +propagate that work, subject to this License. You are not responsible
    +for enforcing compliance by third parties with this License.
    +
    + An "entity transaction" is a transaction transferring control of an
    +organization, or substantially all assets of one, or subdividing an
    +organization, or merging organizations. If propagation of a covered
    +work results from an entity transaction, each party to that
    +transaction who receives a copy of the work also receives whatever
    +licenses to the work the party's predecessor in interest had or could
    +give under the previous paragraph, plus a right to possession of the
    +Corresponding Source of the work from the predecessor in interest, if
    +the predecessor has it or can get it with reasonable efforts.
    +
    + You may not impose any further restrictions on the exercise of the
    +rights granted or affirmed under this License. For example, you may
    +not impose a license fee, royalty, or other charge for exercise of
    +rights granted under this License, and you may not initiate litigation
    +(including a cross-claim or counterclaim in a lawsuit) alleging that
    +any patent claim is infringed by making, using, selling, offering for
    +sale, or importing the Program or any portion of it.
    +
    + 11. Patents.
    +
    + A "contributor" is a copyright holder who authorizes use under this
    +License of the Program or a work on which the Program is based. The
    +work thus licensed is called the contributor's "contributor version".
    +
    + A contributor's "essential patent claims" are all patent claims
    +owned or controlled by the contributor, whether already acquired or
    +hereafter acquired, that would be infringed by some manner, permitted
    +by this License, of making, using, or selling its contributor version,
    +but do not include claims that would be infringed only as a
    +consequence of further modification of the contributor version. For
    +purposes of this definition, "control" includes the right to grant
    +patent sublicenses in a manner consistent with the requirements of
    +this License.
    +
    + Each contributor grants you a non-exclusive, worldwide, royalty-free
    +patent license under the contributor's essential patent claims, to
    +make, use, sell, offer for sale, import and otherwise run, modify and
    +propagate the contents of its contributor version.
    +
    + In the following three paragraphs, a "patent license" is any express
    +agreement or commitment, however denominated, not to enforce a patent
    +(such as an express permission to practice a patent or covenant not to
    +sue for patent infringement). To "grant" such a patent license to a
    +party means to make such an agreement or commitment not to enforce a
    +patent against the party.
    +
    + If you convey a covered work, knowingly relying on a patent license,
    +and the Corresponding Source of the work is not available for anyone
    +to copy, free of charge and under the terms of this License, through a
    +publicly available network server or other readily accessible means,
    +then you must either (1) cause the Corresponding Source to be so
    +available, or (2) arrange to deprive yourself of the benefit of the
    +patent license for this particular work, or (3) arrange, in a manner
    +consistent with the requirements of this License, to extend the patent
    +license to downstream recipients. "Knowingly relying" means you have
    +actual knowledge that, but for the patent license, your conveying the
    +covered work in a country, or your recipient's use of the covered work
    +in a country, would infringe one or more identifiable patents in that
    +country that you have reason to believe are valid.
    +
    + If, pursuant to or in connection with a single transaction or
    +arrangement, you convey, or propagate by procuring conveyance of, a
    +covered work, and grant a patent license to some of the parties
    +receiving the covered work authorizing them to use, propagate, modify
    +or convey a specific copy of the covered work, then the patent license
    +you grant is automatically extended to all recipients of the covered
    +work and works based on it.
    +
    + A patent license is "discriminatory" if it does not include within
    +the scope of its coverage, prohibits the exercise of, or is
    +conditioned on the non-exercise of one or more of the rights that are
    +specifically granted under this License. You may not convey a covered
    +work if you are a party to an arrangement with a third party that is
    +in the business of distributing software, under which you make payment
    +to the third party based on the extent of your activity of conveying
    +the work, and under which the third party grants, to any of the
    +parties who would receive the covered work from you, a discriminatory
    +patent license (a) in connection with copies of the covered work
    +conveyed by you (or copies made from those copies), or (b) primarily
    +for and in connection with specific products or compilations that
    +contain the covered work, unless you entered into that arrangement,
    +or that patent license was granted, prior to 28 March 2007.
    +
    + Nothing in this License shall be construed as excluding or limiting
    +any implied license or other defenses to infringement that may
    +otherwise be available to you under applicable patent law.
    +
    + 12. No Surrender of Others' Freedom.
    +
    + If conditions are imposed on you (whether by court order, agreement or
    +otherwise) that contradict the conditions of this License, they do not
    +excuse you from the conditions of this License. If you cannot convey a
    +covered work so as to satisfy simultaneously your obligations under this
    +License and any other pertinent obligations, then as a consequence you may
    +not convey it at all. For example, if you agree to terms that obligate you
    +to collect a royalty for further conveying from those to whom you convey
    +the Program, the only way you could satisfy both those terms and this
    +License would be to refrain entirely from conveying the Program.
    +
    + 13. Use with the GNU Affero General Public License.
    +
    + Notwithstanding any other provision of this License, you have
    +permission to link or combine any covered work with a work licensed
    +under version 3 of the GNU Affero General Public License into a single
    +combined work, and to convey the resulting work. The terms of this
    +License will continue to apply to the part which is the covered work,
    +but the special requirements of the GNU Affero General Public License,
    +section 13, concerning interaction through a network will apply to the
    +combination as such.
    +
    + 14. Revised Versions of this License.
    +
    + The Free Software Foundation may publish revised and/or new versions of
    +the GNU General Public License from time to time. Such new versions will
    +be similar in spirit to the present version, but may differ in detail to
    +address new problems or concerns.
    +
    + Each version is given a distinguishing version number. If the
    +Program specifies that a certain numbered version of the GNU General
    +Public License "or any later version" applies to it, you have the
    +option of following the terms and conditions either of that numbered
    +version or of any later version published by the Free Software
    +Foundation. If the Program does not specify a version number of the
    +GNU General Public License, you may choose any version ever published
    +by the Free Software Foundation.
    +
    + If the Program specifies that a proxy can decide which future
    +versions of the GNU General Public License can be used, that proxy's
    +public statement of acceptance of a version permanently authorizes you
    +to choose that version for the Program.
    +
    + Later license versions may give you additional or different
    +permissions. However, no additional obligations are imposed on any
    +author or copyright holder as a result of your choosing to follow a
    +later version.
    +
    + 15. Disclaimer of Warranty.
    +
    + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
    +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
    +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
    +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
    +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
    +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
    +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
    +
    + 16. Limitation of Liability.
    +
    + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
    +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
    +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
    +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
    +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
    +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
    +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
    +SUCH DAMAGES.
    +
    + 17. Interpretation of Sections 15 and 16.
    +
    + If the disclaimer of warranty and limitation of liability provided
    +above cannot be given local legal effect according to their terms,
    +reviewing courts shall apply local law that most closely approximates
    +an absolute waiver of all civil liability in connection with the
    +Program, unless a warranty or assumption of liability accompanies a
    +copy of the Program in return for a fee.
    +
    + END OF TERMS AND CONDITIONS
    +
    + How to Apply These Terms to Your New Programs
    +
    + If you develop a new program, and you want it to be of the greatest
    +possible use to the public, the best way to achieve this is to make it
    +free software which everyone can redistribute and change under these terms.
    +
    + To do so, attach the following notices to the program. It is safest
    +to attach them to the start of each source file to most effectively
    +state the exclusion of warranty; and each file should have at least
    +the "copyright" line and a pointer to where the full notice is found.
    +
    + <one line to give the program's name and a brief idea of what it does.>
    + Copyright (C) <year> <name of author>
    +
    + This program is free software: you can redistribute it and/or modify
    + it under the terms of the GNU General Public License as published by
    + the Free Software Foundation, either version 3 of the License, or
    + (at your option) any later version.
    +
    + This program is distributed in the hope that it will be useful,
    + but WITHOUT ANY WARRANTY; without even the implied warranty of
    + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    + GNU General Public License for more details.
    +
    + You should have received a copy of the GNU General Public License
    + along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +Also add information on how to contact you by electronic and paper mail.
    +
    + If the program does terminal interaction, make it output a short
    +notice like this when it starts in an interactive mode:
    +
    + <program> Copyright (C) <year> <name of author>
    + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    + This is free software, and you are welcome to redistribute it
    + under certain conditions; type `show c' for details.
    +
    +The hypothetical commands `show w' and `show c' should show the appropriate
    +parts of the General Public License. Of course, your program's commands
    +might be different; for a GUI interface, you would use an "about box".
    +
    + You should also get your employer (if you work as a programmer) or school,
    +if any, to sign a "copyright disclaimer" for the program, if necessary.
    +For more information on this, and how to apply and follow the GNU GPL, see
    +<http://www.gnu.org/licenses/>.
    +
    + The GNU General Public License does not permit incorporating your program
    +into proprietary programs. If your program is a subroutine library, you
    +may consider it more useful to permit linking proprietary applications with
    +the library. If this is what you want to do, use the GNU Lesser General
    +Public License instead of this License. But first, please read
    +<http://www.gnu.org/philosophy/why-not-lgpl.html>.
    \ No newline at end of file
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/README.md Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,37 @@
    +# govcs
    +
    +govcs is a simple abstraction layer around version control tools. It currently
    +supports Git and Mercurial. With it you can get information about the
    +repository including remotes, branches, commits, etc.
    +
    +[![GoDoc](https://godoc.org/keep.imfreedom.org/grim/govcs?status.svg)](https://godoc.org/keep.imfreedom.org/grim/govcs)
    +
    +# License
    +
    +GPLv3
    +
    +# Installation
    +
    + go get keep.imfreedom.org/grim/govcs
    +
    +# Example
    +
    +This simple example will output the default remote for the repository in the
    +`my-src-dir` directory.
    +
    + package main
    +
    + import(
    + "fmt"
    +
    + "keep.imfreedom.org/grim/govcs"
    + )
    +
    + func main() {
    + vcs, err := govcs.Dectect("my-src-dir")
    + if err != nil {
    + panic(err)
    + }
    +
    + fmt.Printf("remote: %s\n", vcs.Remote(""))
    + }
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/exec/command.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,22 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +//
    +package exec
    +
    +type Cmd interface {
    + Output() ([]byte, error)
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/exec/exec.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,52 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package exec mocks running commands. The mocks are used for unit testing.
    +package exec
    +
    +import (
    + "os/exec"
    + "sync"
    +)
    +
    +type ExecBackend func(name string, args ...string) Cmd
    +
    +var (
    + activeBackend ExecBackend
    + lock sync.Mutex
    +)
    +
    +func init() {
    + SetBackend(func(name string, args ...string) Cmd {
    + cmd := exec.Command(name, args...)
    + return Cmd(cmd)
    + })
    +}
    +
    +func SetBackend(backend ExecBackend) {
    + lock.Lock()
    + defer lock.Unlock()
    +
    + activeBackend = backend
    +}
    +
    +func Backend() ExecBackend {
    + return activeBackend
    +}
    +
    +func Command(name string, args ...string) Cmd {
    + return activeBackend(name, args...)
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/exec/mock.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,64 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +//
    +package exec
    +
    +import (
    + "sync"
    +)
    +
    +type MockResult struct {
    + Stdout []byte
    + Err error
    +}
    +
    +func NewMockResult(stdout string, err error) *MockResult {
    + return &MockResult{
    + Stdout: []byte(stdout),
    + Err: err,
    + }
    +}
    +
    +type MockCommand struct {
    + outputLock sync.Mutex
    +
    + curResult int
    + results []*MockResult
    +}
    +
    +func NewMockCommand(results ...*MockResult) *MockCommand {
    + return &MockCommand{
    + results: results,
    + }
    +}
    +
    +func (c *MockCommand) Output() ([]byte, error) {
    + c.outputLock.Lock()
    + defer c.outputLock.Unlock()
    +
    + if len(c.results) == 0 {
    + return nil, nil
    + }
    +
    + res := c.results[c.curResult]
    +
    + if c.curResult < len(c.results)-1 {
    + c.curResult++
    + }
    +
    + return res.Stdout, res.Err
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/exec/mock_test.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,57 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +package exec
    +
    +import (
    + "errors"
    + "testing"
    +
    + "github.com/stretchr/testify/assert"
    +)
    +
    +func TestCommandNoResult(t *testing.T) {
    + cmd := NewMockCommand()
    +
    + out, err := cmd.Output()
    + assert.Nil(t, out)
    + assert.Nil(t, err)
    +}
    +
    +func TestCommandSingleResult(t *testing.T) {
    + cmd := NewMockCommand(
    + NewMockResult("output", errors.New("err")),
    + )
    +
    + out, err := cmd.Output()
    + assert.Equal(t, []byte("output"), out)
    + assert.Equal(t, errors.New("err"), err)
    +}
    +
    +func TestCommandMultipleResult(t *testing.T) {
    + cmd := NewMockCommand(
    + NewMockResult("output1", errors.New("err1")),
    + NewMockResult("output2", errors.New("err2")),
    + )
    +
    + out, err := cmd.Output()
    + assert.Equal(t, []byte("output1"), out)
    + assert.Equal(t, errors.New("err1"), err)
    +
    + out, err = cmd.Output()
    + assert.Equal(t, []byte("output2"), out)
    + assert.Equal(t, errors.New("err2"), err)
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/git/git.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,139 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package git interacts with Git repositories.
    +package git
    +
    +import (
    + "os"
    + "strings"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    + "keep.imfreedom.org/grim/convey/govcs/vcs"
    +)
    +
    +func handleRevParseError(out string, err error) string {
    + if err == nil {
    + return out
    + }
    +
    + // This handles the case where a user is in a git repo without any
    + // commits yet. Git returns an error as if it's outside the repo
    + // but still prints "HEAD" to stdout.
    + if err != nil && out == "HEAD" {
    + return out
    + }
    +
    + return ""
    +}
    +
    +// Git is an instance of vcs.VCS that will operate on a Git repository.
    +type Git struct {
    + wd string
    +}
    +
    +// Detect will return a vcs.VCS instance if the given working directory is a
    +// Git repository.
    +func Detect(wd string) vcs.VCS {
    + g := &Git{
    + wd: wd,
    + }
    +
    + if g.Commit() != "" {
    + return g
    + }
    +
    + return nil
    +}
    +
    +// Name returns git. This is used so that callers know what vcs they have.
    +func (g *Git) Name() string {
    + return "git"
    +}
    +
    +// Remote will return the url for the given remote or 'origin' if no remote
    +// is provided. If the repository does not have the given remote, empty string
    +// will be returned.
    +func (g *Git) Remote(name string) string {
    + if name == "" {
    + name = "origin"
    + }
    +
    + out, err := g.runCmd([]string{"config", "--local", "remote." + name + ".url"})
    + if err != nil {
    + return ""
    + }
    +
    + return out
    +}
    +
    +// Root will return the root of the repository.
    +func (g *Git) Root() string {
    + out, err := g.runCmd([]string{"rev-parse", "--show-toplevel"})
    + if err != nil {
    + return ""
    + }
    + return out
    +}
    +
    +// Commit will return the commit id of the repository.
    +func (g *Git) Commit() string {
    + out, err := g.runCmd([]string{"rev-parse", "HEAD"})
    + return handleRevParseError(out, err)
    +}
    +
    +// ShortCommit returns the short commit id of the repository.
    +func (g *Git) ShortCommit() string {
    + out, err := g.runCmd([]string{"rev-parse", "--short", "HEAD"})
    + if err != nil {
    + // If we can't get a short commit hash, try to get the full one.
    + // This is here to handle the case where a repo doesn't have any commits
    + // yet and returns a failure for the --short option but returns HEAD
    + // for the full commit id.
    + return g.Commit()
    + }
    +
    + return out
    +}
    +
    +// Branch returns the name of the checked out branch.
    +func (g *Git) Branch() string {
    + out, err := g.runCmd([]string{"rev-parse", "--abbrev-ref", "HEAD"})
    + return handleRevParseError(out, err)
    +}
    +
    +// Config will look up the given key and return a string slice of the values.
    +func (g *Git) Config(key string) []string {
    + output, err := g.runCmd([]string{"config", key})
    + if err != nil {
    + output = ""
    + }
    +
    + return strings.Split(output, "\n")
    +}
    +
    +// runCmd will run the git command without the users config, it will also set
    +// working directory. All you need to pass in is a string slice of the
    +// subcommand that you want to run.
    +func (g *Git) runCmd(cmdv []string) (string, error) {
    + os.Setenv("GIT_CONFIG_NOSYSTEM", "1")
    +
    + args := append([]string{"-C", g.wd}, cmdv...)
    + cmd := exec.Command("git", args...)
    + output, err := cmd.Output()
    +
    + return strings.TrimSpace(string(output)), err
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/git/git_test.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,128 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +package git
    +
    +import (
    + "errors"
    + "testing"
    +
    + "github.com/stretchr/testify/assert"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    +)
    +
    +func setup(cmd exec.Cmd) exec.ExecBackend {
    + backend := exec.Backend()
    +
    + exec.SetBackend(func(name string, args ...string) exec.Cmd {
    + return cmd
    + })
    +
    + return backend
    +}
    +
    +func TestDetectFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("found", nil)))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("working-directory")
    + assert.NotNil(t, vcs)
    +
    + git, ok := vcs.(*Git)
    +
    + assert.True(t, ok)
    + assert.Equal(t, "working-directory", git.wd)
    +}
    +
    +func TestDetectNotFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("", errors.New("not found"))))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("")
    + assert.Nil(t, vcs)
    +}
    +
    +func TestRemoteEmpty(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("https://keep.imfreedom.org/grim/govcs\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    +
    + assert.Equal(t, "https://keep.imfreedom.org/grim/govcs", git.Remote(""))
    +}
    +
    +func TestRemoteNamed(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("https://keep.imfreedom.org/grim/govcs2\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, "https://keep.imfreedom.org/grim/govcs2", git.Remote("upstream"))
    +}
    +
    +func TestRoot(t *testing.T) {
    + path := "/home/foo/go/src/github.com/bar/baz"
    + backend := setup(exec.NewMockCommand(exec.NewMockResult(path+"\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, path, git.Root())
    +}
    +
    +func TestCommit(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("deadbeef", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, "deadbeef", git.Commit())
    +}
    +
    +func TestCommitOnEmptyRepo(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("HEAD", errors.New("exited"))))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, "HEAD", git.Commit())
    +}
    +
    +func TestShortCommitOnEmptyRepo(t *testing.T) {
    + backend := setup(exec.NewMockCommand(
    + // Short commit returns an error and an empty output
    + exec.NewMockResult("", errors.New("exited")),
    + // We then call normal commit and that returns HEAD and an error
    + exec.NewMockResult("HEAD", errors.New("exited")),
    + ))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, "HEAD", git.ShortCommit())
    +}
    +
    +func TestBranch(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("my-fancy-branch", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, "my-fancy-branch", git.Branch())
    +}
    +
    +func TestConfigUserEmail(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("grim@reaperworld.com\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + git := Git{}
    + assert.Equal(t, []string{"grim@reaperworld.com"}, git.Config("user.email"))
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/govcs.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,76 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package govcs is the entry point to using the govcs library.
    +package govcs
    +
    +import (
    + "errors"
    +
    + "keep.imfreedom.org/grim/convey/govcs/git"
    + "keep.imfreedom.org/grim/convey/govcs/hg"
    + "keep.imfreedom.org/grim/convey/govcs/vcs"
    +)
    +
    +type detectorFunc func(wd string) vcs.VCS
    +
    +var (
    + detectors = []detectorFunc{
    + git.Detect,
    + hg.Detect,
    + }
    +
    + ErrNoRepositoryFound = errors.New("no repository found")
    +)
    +
    +// Detect will try to determine what version control system is in use in the
    +// given working directory and return a vcs.VCS instance for it.
    +func Detect(wd string) (vcs.VCS, error) {
    + var instance vcs.VCS
    +
    + for _, detector := range detectors {
    + inst := detector(wd)
    +
    + // we found a VCS
    + if inst != nil {
    + // if we found one previously, check who's root is longer so that
    + // we return the right vcs when they're nested.
    + // for example if we have
    + //
    + // foo/
    + // .git/
    + // bar/
    + // .hg/
    + //
    + // and we're testing bar, due to the order of the list we'd return
    + // a Git instance since it's first, but it really should be a
    + // mercurial instance.
    + if instance != nil {
    + if len(inst.Root()) > len(instance.Root()) {
    + instance = inst
    + }
    + } else {
    + instance = inst
    + }
    + }
    + }
    +
    + if instance != nil {
    + return instance, nil
    + }
    +
    + return nil, ErrNoRepositoryFound
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/govcs_test.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,82 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +package govcs
    +
    +import (
    + "errors"
    + "testing"
    +
    + "github.com/stretchr/testify/assert"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    + "keep.imfreedom.org/grim/convey/govcs/git"
    + "keep.imfreedom.org/grim/convey/govcs/hg"
    +)
    +
    +func setup(cmdName string, cmd exec.Cmd) exec.ExecBackend {
    + backend := exec.Backend()
    +
    + exec.SetBackend(func(name string, args ...string) exec.Cmd {
    + if name == cmdName {
    + return cmd
    + }
    +
    + return exec.NewMockCommand(
    + exec.NewMockResult(
    + "",
    + errors.New("not a "+cmdName+" repo"),
    + ),
    + )
    + })
    +
    + return backend
    +}
    +
    +func TestFindGitFromGit(t *testing.T) {
    + backend := setup("git", exec.NewMockCommand(exec.NewMockResult("found", nil)))
    + defer exec.SetBackend(backend)
    +
    + vcs, err := Detect("working-directory")
    + assert.NotNil(t, vcs)
    + assert.Nil(t, err)
    +
    + g, ok := vcs.(*git.Git)
    + assert.True(t, ok)
    + assert.IsType(t, &git.Git{}, g)
    +}
    +
    +func TestFindHgFromHg(t *testing.T) {
    + backend := setup("hg", exec.NewMockCommand(exec.NewMockResult("found", nil)))
    + defer exec.SetBackend(backend)
    +
    + vcs, err := Detect("working-directory")
    + assert.NotNil(t, vcs)
    + assert.Nil(t, err)
    +
    + m, ok := vcs.(*hg.Mercurial)
    + assert.True(t, ok)
    + assert.IsType(t, &hg.Mercurial{}, m)
    +}
    +
    +func TestFindNoRepository(t *testing.T) {
    + backend := setup("", exec.NewMockCommand(exec.NewMockResult("", errors.New("not a repo"))))
    + defer exec.SetBackend(backend)
    +
    + vcs, err := Detect("working-directory")
    + assert.Nil(t, vcs)
    + assert.Error(t, ErrNoRepositoryFound, err)
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/hg/hg.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,122 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package hg interacts with Mercurial repositories.
    +package hg
    +
    +import (
    + "os"
    + "strings"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    + "keep.imfreedom.org/grim/convey/govcs/vcs"
    +)
    +
    +// Mercurial is an instance of vcs.VCS that will operate on a Mercurial
    +// repository.
    +type Mercurial struct {
    + wd string
    +}
    +
    +// Detect will return a vcs.VCS instance if the given working directory
    +// is a Mercurial repository.
    +func Detect(wd string) vcs.VCS {
    + hg := &Mercurial{
    + wd: wd,
    + }
    +
    + output := hg.runCmd([]string{"id", "-q"})
    +
    + if output != "" {
    + return hg
    + }
    +
    + return nil
    +}
    +
    +// Name returns hg. This is used so that callers know what vcs they have.
    +func (m *Mercurial) Name() string {
    + return "hg"
    +}
    +
    +// Remote will return the url for the given remote or 'default' if no remote
    +// is provided. If the repository does not have the given remote, empty string
    +// will be returned.
    +func (m *Mercurial) Remote(name string) string {
    + if name == "" {
    + name = "default"
    + }
    +
    + remotes := m.Config("paths." + name)
    + if len(remotes) == 1 {
    + return remotes[0]
    + }
    +
    + return ""
    +}
    +
    +// Root will return the root of the repository.
    +func (m *Mercurial) Root() string {
    + return m.runCmd([]string{"root"})
    +}
    +
    +// Commit will return the commit id of the repository.
    +func (m *Mercurial) Commit() string {
    + return m.runLog("{node}")
    +}
    +
    +// ShortCommit returns the short commit id of the repository.
    +func (m *Mercurial) ShortCommit() string {
    + return m.runLog("{node|short}")
    +}
    +
    +// Branch returns the name of the checked out branch.
    +func (m *Mercurial) Branch() string {
    + return m.runLog("{branch}")
    +}
    +
    +// Bookmark returns the name of the active bookmark.
    +func (m *Mercurial) Bookmark() string {
    + return m.runLog("{activebookmark}")
    +}
    +
    +// Config will look up the given key and return a string slice of the values.
    +func (m *Mercurial) Config(key string) []string {
    + output := m.runCmd([]string{"config", key})
    +
    + return strings.Split(string(output), "\n")
    +}
    +
    +// runLog will runs `hg log` with the given template
    +func (m *Mercurial) runLog(template string) string {
    + return m.runCmd([]string{"log", "-r", ".", "-T", template})
    +}
    +
    +// runCmd will run the hg command without the users config, it will also set
    +// working directory. All you need to pass in is a string slice of the
    +// subcommand that you want to run.
    +func (m *Mercurial) runCmd(cmdv []string) string {
    + os.Setenv("HGRCPATH", "/dev/null")
    +
    + args := append([]string{"--cwd", m.wd}, cmdv...)
    + cmd := exec.Command("hg", args...)
    + output, err := cmd.Output()
    + if err != nil {
    + return ""
    + }
    +
    + return strings.TrimSpace(string(output))
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/hg/hg_test.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,116 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +package hg
    +
    +import (
    + "errors"
    + "testing"
    +
    + "github.com/stretchr/testify/assert"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    +)
    +
    +func setup(cmd exec.Cmd) exec.ExecBackend {
    + backend := exec.Backend()
    +
    + exec.SetBackend(func(name string, args ...string) exec.Cmd {
    + return cmd
    + })
    +
    + return backend
    +}
    +
    +func TestDetectFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("found", nil)))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("working-directory")
    + assert.NotNil(t, vcs)
    +
    + hg, ok := vcs.(*Mercurial)
    + assert.True(t, ok)
    + assert.Equal(t, "working-directory", hg.wd)
    +}
    +
    +func TestDetectNotFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("", errors.New("not found"))))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("")
    + assert.Nil(t, vcs)
    +}
    +
    +func TestRemoteEmpty(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("mypath\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    +
    + assert.Equal(t, "mypath", hg.Remote(""))
    +}
    +
    +func TestRemoteNamed(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("myupstream\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, "myupstream", hg.Remote("upstream"))
    +}
    +
    +func TestRoot(t *testing.T) {
    + path := "/home/foo/go/src/keep.imfreedom.org/bar/baz"
    + backend := setup(exec.NewMockCommand(exec.NewMockResult(path+"\n", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, path, hg.Root())
    +}
    +
    +func TestCommit(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("deadbeef", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, "deadbeef", hg.Commit())
    +}
    +
    +func TestBranch(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("my-fancy-branch", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, "my-fancy-branch", hg.Branch())
    +}
    +
    +func TestBookmark(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("my-fancy-bookmark", nil)))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, "my-fancy-bookmark", hg.Bookmark())
    +}
    +
    +func TestConfigPaths(t *testing.T) {
    + backend := setup(exec.NewMockCommand(
    + exec.NewMockResult("paths.default=default\npaths.upstream=upstream\n", nil),
    + ))
    + defer exec.SetBackend(backend)
    +
    + hg := Mercurial{}
    + assert.Equal(t, []string{"paths.default=default", "paths.upstream=upstream"}, hg.Config("paths"))
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/svn/svn.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,122 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package git interacts with Git repositories.
    +package svn
    +
    +import (
    + "encoding/xml"
    + "strings"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    + "keep.imfreedom.org/grim/convey/govcs/vcs"
    +)
    +
    +type svnCommit struct {
    + Revision string `xml:"revision,attr"`
    +}
    +
    +type rawSubversion struct {
    + Remote string `xml:"entry>repository>root"`
    + Root string `xml:"entry>wc-info>wcroot-abspath"`
    + Commit svnCommit `xml:"entry>commit"`
    + Branch string `xml:"entry>relative-url"`
    +}
    +
    +// SVN is an instance of vcs.VCS that will operate on a Subversion repository.
    +type Subversion struct {
    + wd string
    + raw rawSubversion
    +}
    +
    +// Detect will return a vcs.VCS instance if the given working directory is a
    +// Git repository.
    +func Detect(wd string) vcs.VCS {
    + s := &Subversion{
    + wd: wd,
    + }
    +
    + err := s.info()
    + if err != nil {
    + return nil
    + }
    +
    + return s
    +}
    +
    +// Name returns svn. This is used so that callers know what vcs they have.
    +func (s *Subversion) Name() string {
    + return "svn"
    +}
    +
    +// Remote will return the url for repository. The given remote name is ignored
    +// as subversion does not support multiple remotes.
    +func (s *Subversion) Remote(name string) string {
    + return s.raw.Remote
    +}
    +
    +// Root will return the root of the repository.
    +func (s *Subversion) Root() string {
    + return s.raw.Root
    +}
    +
    +// Commit will return the commit id of the repository.
    +func (s *Subversion) Commit() string {
    + return s.raw.Commit.Revision
    +}
    +
    +// ShortCommit returns the short commit id of the repository.
    +func (s *Subversion) ShortCommit() string {
    + return s.raw.Commit.Revision
    +}
    +
    +// Branch returns the name of the checked out branch.
    +func (s *Subversion) Branch() string {
    + return s.raw.Branch
    +}
    +
    +// Config will look up the given key and return a string slice of the values.
    +func (s *Subversion) Config(key string) []string {
    + return []string{}
    +}
    +
    +// run `svn info $WD` and store the results in s.raw
    +func (s *Subversion) info() error {
    + cmd := exec.Command("svn", "info", "--config-dir", "/dev/null", s.wd)
    + output, err := cmd.Output()
    + if err != nil {
    + return err
    + }
    +
    + var raw rawSubversion
    + err = xml.Unmarshal(output, &raw)
    + if err != nil {
    + return err
    + }
    +
    + s.raw = raw
    +
    + // parse the branch now
    + if s.raw.Branch == "^/trunk" {
    + s.raw.Branch = "trunk"
    + } else if strings.HasPrefix(s.raw.Branch, "^/branches/") {
    + s.raw.Branch = s.raw.Branch[11:]
    + } else if strings.HasPrefix(s.raw.Branch, "^/tags/") {
    + s.raw.Branch = s.raw.Branch[7:]
    + }
    +
    + return nil
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/svn/svn_test.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,89 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +package svn
    +
    +import (
    + "errors"
    + "testing"
    +
    + "github.com/stretchr/testify/assert"
    +
    + "keep.imfreedom.org/grim/convey/govcs/exec"
    +)
    +
    +var (
    + data = `<?xml version="1.0" encoding="UTF-8"?>
    +<info>
    +<entry
    + kind="dir"
    + path="."
    + revision="1">
    +<url>file:///vcs/svn-repo/trunk</url>
    +<relative-url>^/trunk</relative-url>
    +<repository>
    +<root>file:///vcs/svn-repo</root>
    +<uuid>6469bf1c-c3bf-4669-9443-0d5bf139ee55</uuid>
    +</repository>
    +<wc-info>
    +<wcroot-abspath>/vcs/foo/bar/baz</wcroot-abspath>
    +<schedule>normal</schedule>
    +<depth>infinity</depth>
    +</wc-info>
    +<commit
    + revision="1">
    +<author>grim</author>
    +<date>2017-12-28T03:24:37.037145Z</date>
    +</commit>
    +</entry>
    +</info>`
    +)
    +
    +func setup(cmd exec.Cmd) exec.ExecBackend {
    + backend := exec.Backend()
    +
    + exec.SetBackend(func(name string, args ...string) exec.Cmd {
    + return cmd
    + })
    +
    + return backend
    +}
    +
    +func TestDetectFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult(data, nil)))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("working-directory")
    + assert.NotNil(t, vcs)
    +
    + svn, ok := vcs.(*Subversion)
    + assert.True(t, ok)
    + assert.Equal(t, "working-directory", svn.wd)
    +
    + assert.Equal(t, "/vcs/foo/bar/baz", svn.Root())
    + assert.Equal(t, "file:///vcs/svn-repo", svn.Remote(""))
    + assert.Equal(t, "1", svn.Commit())
    + assert.Equal(t, "1", svn.ShortCommit())
    + assert.Equal(t, "trunk", svn.Branch())
    +}
    +
    +func TestDetectNotFound(t *testing.T) {
    + backend := setup(exec.NewMockCommand(exec.NewMockResult("", errors.New("not found"))))
    + defer exec.SetBackend(backend)
    +
    + vcs := Detect("")
    + assert.Nil(t, vcs)
    +}
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/govcs/vcs/vcs.go Mon Oct 18 00:39:41 2021 -0500
    @@ -0,0 +1,44 @@
    +// govcs
    +// Copyright 2017-2019 Gary Kramlich <grim@reaperworld.com>
    +//
    +// This program is free software: you can redistribute it and/or modify
    +// it under the terms of the GNU General Public License as published by
    +// the Free Software Foundation, either version 3 of the License, or
    +// (at your option) any later version.
    +//
    +// This program is distributed in the hope that it will be useful,
    +// but WITHOUT ANY WARRANTY; without even the implied warranty of
    +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +// GNU General Public License for more details.
    +//
    +// You should have received a copy of the GNU General Public License
    +// along with this program. If not, see <http://www.gnu.org/licenses/>.
    +
    +// Package vcs abstracts VCS interactions.
    +package vcs
    +
    +// VCS is an interface into the individual version control tools.
    +type VCS interface {
    + // Name is a short string naming the vcs. Ie: git, hg, svn
    + Name() string
    +
    + // Remote will return the url for the given remote. If no remote is given
    + // the default for the version control system will be used.
    + Remote(name string) string
    +
    + // Root will return the root of the repository.
    + Root() string
    +
    + // Commit returns the current commit id of repository.
    + Commit() string
    +
    + // ShortCommit returns a shortened form of Commit().
    + ShortCommit() string
    +
    + // Branch returns the currently checked out branch of the repository.
    + Branch() string
    +
    + // Config will look up a setting in the configuration for the repository
    + // and return a slice of values for the given key.
    + Config(key string) []string
    +}