// Copyright 2018 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package integrations import ( "net/http" "testing" "code.gitea.io/gitea/models" api "code.gitea.io/gitea/modules/structs" ) // TestAPICreateAndDeleteToken tests that token that was just created can be deleted func TestAPICreateAndDeleteToken(t *testing.T) { defer prepareTestEnv(t)() user := models.AssertExistsAndLoadBean(t, &models.User{ID: 1}).(*models.User) req := NewRequestWithJSON(t, "POST", "/api/v1/users/user1/tokens", map[string]string{ "name": "test-key-1", }) req = AddBasicAuthHeader(req, user.Name) resp := MakeRequest(t, req, http.StatusCreated) var newAccessToken api.AccessToken DecodeJSON(t, resp, &newAccessToken) models.AssertExistsAndLoadBean(t, &models.AccessToken{ ID: newAccessToken.ID, Name: newAccessToken.Name, Token: newAccessToken.Token, UID: user.ID, }) req = NewRequestf(t, "DELETE", "/api/v1/users/user1/tokens/%d", newAccessToken.ID) req = AddBasicAuthHeader(req, user.Name) MakeRequest(t, req, http.StatusNoContent) models.AssertNotExistsBean(t, &models.AccessToken{ID: newAccessToken.ID}) } // TestAPIDeleteMissingToken ensures that error is thrown when token not found func TestAPIDeleteMissingToken(t *testing.T) { defer prepareTestEnv(t)() user := models.AssertExistsAndLoadBean(t, &models.User{ID: 1}).(*models.User) req := NewRequestf(t, "DELETE", "/api/v1/users/user1/tokens/%d", models.NonexistentID) req = AddBasicAuthHeader(req, user.Name) MakeRequest(t, req, http.StatusNotFound) } value='release/v1.22-legacy'>release/v1.22-legacy</option> <option value='release/v1.23'>release/v1.23</option> <option value='release/v1.8'>release/v1.8</option> <option value='release/v1.9'>release/v1.9</option> </select> <input type='submit' value='switch'/></form></td></tr> <tr><td class='sub'>Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD: https://github.com/go-gitea/gitea</td><td class='sub right'>www-data</td></tr></table> <table class='tabs'><tr><td> <a href='/gitea.git/?h=v1.22.0-rc1'>summary</a><a href='/gitea.git/refs/?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>refs</a><a href='/gitea.git/log/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1'>log</a><a class='active' href='/gitea.git/tree/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>tree</a><a href='/gitea.git/commit/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>commit</a><a href='/gitea.git/diff/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>diff</a><a href='/gitea.git/stats/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1'>stats</a></td><td class='form'><form class='right' method='get' action='/gitea.git/log/docs/content/doc/usage/packages/go.en-us.md'> <input type='hidden' name='h' value='v1.22.0-rc1'/><input type='hidden' name='id' value='37895b61c0ea6594dc562f0058429418c48eb339'/><select name='qt'> <option value='grep'>log msg</option> <option value='author'>author</option> <option value='committer'>committer</option> <option value='range'>range</option> </select> <input class='txt' type='search' size='10' name='q' value=''/> <input type='submit' value='search'/> </form> </td></tr></table> <div class='path'>path: <a href='/gitea.git/tree/?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>root</a>/<a href='/gitea.git/tree/docs?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>docs</a>/<a href='/gitea.git/tree/docs/content?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>content</a>/<a href='/gitea.git/tree/docs/content/doc?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>doc</a>/<a href='/gitea.git/tree/docs/content/doc/usage?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>usage</a>/<a href='/gitea.git/tree/docs/content/doc/usage/packages?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>packages</a>/<a href='/gitea.git/tree/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>go.en-us.md</a></div><div class='content'>blob: 04452c35168c9250b9950132c7aecb29b46ab014 (<a href='/gitea.git/plain/docs/content/doc/usage/packages/go.en-us.md?h=v1.22.0-rc1&id=37895b61c0ea6594dc562f0058429418c48eb339'>plain</a>) <table summary='blob content' class='blob'> <tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a> <a id='n2' href='#n2'>2</a> <a id='n3' href='#n3'>3</a> <a id='n4' href='#n4'>4</a> <a id='n5' href='#n5'>5</a> <a id='n6' href='#n6'>6</a> <a id='n7' href='#n7'>7</a> <a id='n8' href='#n8'>8</a> <a id='n9' href='#n9'>9</a> <a id='n10' href='#n10'>10</a> <a id='n11' href='#n11'>11</a> <a id='n12' href='#n12'>12</a> <a id='n13' href='#n13'>13</a> <a id='n14' href='#n14'>14</a> <a id='n15' href='#n15'>15</a> <a id='n16' href='#n16'>16</a> <a id='n17' href='#n17'>17</a> <a id='n18' href='#n18'>18</a> <a id='n19' href='#n19'>19</a> <a id='n20' href='#n20'>20</a> <a id='n21' href='#n21'>21</a> <a id='n22' href='#n22'>22</a> <a id='n23' href='#n23'>23</a> <a id='n24' href='#n24'>24</a> <a id='n25' href='#n25'>25</a> <a id='n26' href='#n26'>26</a> <a id='n27' href='#n27'>27</a> <a id='n28' href='#n28'>28</a> <a id='n29' href='#n29'>29</a> <a id='n30' href='#n30'>30</a> <a id='n31' href='#n31'>31</a> <a id='n32' href='#n32'>32</a> <a id='n33' href='#n33'>33</a> <a id='n34' href='#n34'>34</a> <a id='n35' href='#n35'>35</a> <a id='n36' href='#n36'>36</a> <a id='n37' href='#n37'>37</a> <a id='n38' href='#n38'>38</a> <a id='n39' href='#n39'>39</a> <a id='n40' href='#n40'>40</a> <a id='n41' href='#n41'>41</a> <a id='n42' href='#n42'>42</a> <a id='n43' href='#n43'>43</a> <a id='n44' href='#n44'>44</a> <a id='n45' href='#n45'>45</a> <a id='n46' href='#n46'>46</a> <a id='n47' href='#n47'>47</a> <a id='n48' href='#n48'>48</a> <a id='n49' href='#n49'>49</a> <a id='n50' href='#n50'>50</a> <a id='n51' href='#n51'>51</a> <a id='n52' href='#n52'>52</a> <a id='n53' href='#n53'>53</a> <a id='n54' href='#n54'>54</a> <a id='n55' href='#n55'>55</a> <a id='n56' href='#n56'>56</a> <a id='n57' href='#n57'>57</a> <a id='n58' href='#n58'>58</a> <a id='n59' href='#n59'>59</a> <a id='n60' href='#n60'>60</a> <a id='n61' href='#n61'>61</a> <a id='n62' href='#n62'>62</a> <a id='n63' href='#n63'>63</a> <a id='n64' href='#n64'>64</a> <a id='n65' href='#n65'>65</a> <a id='n66' href='#n66'>66</a> <a id='n67' href='#n67'>67</a> <a id='n68' href='#n68'>68</a> <a id='n69' href='#n69'>69</a> <a id='n70' href='#n70'>70</a> <a id='n71' href='#n71'>71</a> <a id='n72' href='#n72'>72</a> <a id='n73' href='#n73'>73</a> <a id='n74' href='#n74'>74</a> <a id='n75' href='#n75'>75</a> <a id='n76' href='#n76'>76</a> <a id='n77' href='#n77'>77</a> </pre></td> <td class='lines'><pre><code><style>pre { line-height: 125%; } td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span>--- date: "2023-05-10T00:00:00+00:00" title: "Go Package Registry" slug: "go" weight: 45 draft: false toc: false menu: sidebar: parent: "packages" name: "Go" weight: 45 <span class="gu"> identifier: "go"</span> <span class="gu">---</span> <span class="gh"># Go Package Registry</span> Publish Go packages for your user or organization. <span class="gs">**Table of Contents**</span> {{< toc >}} <span class="gu">## Publish a package</span> To publish a Go package perform a HTTP <span class="sb">`PUT`</span> operation with the package content in the request body. You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first. The package must follow the [<span class="nt">documented structure</span>](<span class="na">https://go.dev/ref/mod#zip-files</span>). <span class="sb">```</span> <span class="sb">PUT https://gitea.example.com/api/packages/{owner}/go/upload</span> <span class="sb">```</span> | Parameter | Description | | --------- | ----------- | | <span class="sb">`owner`</span> | The owner of the package. | To authenticate to the package registry, you need to provide [<span class="nt">custom HTTP headers or use HTTP Basic authentication</span>](<span class="na">{{< relref "doc/development/api-usage.en-us.md#authentication" >}}</span>): <span class="sb">```shell</span> curl<span class="w"> </span>--user<span class="w"> </span>your_username:your_password_or_token<span class="w"> </span><span class="se">\</span> <span class="w"> </span>--upload-file<span class="w"> </span>path/to/file.zip<span class="w"> </span><span class="se">\</span> <span class="w"> </span>https://gitea.example.com/api/packages/testuser/go/upload <span class="sb">```</span> If you are using 2FA or OAuth use a [<span class="nt">personal access token</span>](<span class="na">{{< relref "doc/development/api-usage.en-us.md#authentication" >}}</span>) instead of the password. The server responds with the following HTTP Status codes. | HTTP Status Code | Meaning | | ----------------- | ------- | | <span class="sb">`201 Created`</span> | The package has been published. | | <span class="sb">`400 Bad Request`</span> | The package is invalid. | | <span class="sb">`409 Conflict`</span> | A package with the same name exist already. | <span class="gu">## Install a package</span> To install a Go package instruct Go to use the package registry as proxy: <span class="sb">```shell</span> <span class="c1"># use latest version</span> <span class="nv">GOPROXY</span><span class="o">=</span>https://gitea.example.com/api/packages/<span class="o">{</span>owner<span class="o">}</span>/go<span class="w"> </span>go<span class="w"> </span>install<span class="w"> </span><span class="o">{</span>package_name<span class="o">}</span> <span class="c1"># or</span> <span class="nv">GOPROXY</span><span class="o">=</span>https://gitea.example.com/api/packages/<span class="o">{</span>owner<span class="o">}</span>/go<span class="w"> </span>go<span class="w"> </span>install<span class="w"> </span><span class="o">{</span>package_name<span class="o">}</span>@latest <span class="c1"># use specific version</span> <span class="nv">GOPROXY</span><span class="o">=</span>https://gitea.example.com/api/packages/<span class="o">{</span>owner<span class="o">}</span>/go<span class="w"> </span>go<span class="w"> </span>install<span class="w"> </span><span class="o">{</span>package_name<span class="o">}</span>@<span class="o">{</span>package_version<span class="o">}</span> <span class="sb">```</span> | Parameter | Description | | ----------------- | ----------- | | <span class="sb">`owner`</span> | The owner of the package. | | <span class="sb">`package_name`</span> | The package name. | | <span class="sb">`package_version`</span> | The package version. | If the owner of the packages is private you need to [<span class="nt">provide credentials</span>](<span class="na">https://go.dev/ref/mod#private-module-proxy-auth</span>). More information about the <span class="sb">`GOPROXY`</span> environment variable and how to protect against data leaks can be found in [<span class="nt">the documentation</span>](<span class="na">https://go.dev/ref/mod#private-modules</span>). </pre></div>