Skip to content

Commit 5194639

Browse files
atodorovatodorov
committed
Generate Pelican site
1 parent 898df96 commit 5194639

File tree

14 files changed

+964
-428
lines changed

14 files changed

+964
-428
lines changed

‎blog/archives/index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ <h1 class="top-header">Archives</h1>
5050
</header>
5151

5252
<section class="col-12 article secondary">
53+
<h2 class="top-subheader">Sat 11 July 2020</h2>
54+
<p>
55+
<a href="/blog/atodorov/2020/07/11/customize-the-information-used-for-1-click-bug-reports/">Customize the information used for 1-click bug reports</a>
56+
</p>
5357
<h2 class="top-subheader">Fri 10 July 2020</h2>
5458
<p>
5559
<a href="/blog/kiwi-tcms-team/2020/07/10/kiwi-tcms-85/">Kiwi TCMS 8.5</a>

‎blog/atodorov/2019/11/11/how-to-override-bug-details-in-kiwi-tcms/index.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,15 @@ <h2>Option #2: extend bug tracker integration</h2>
200200
<a href="https://github.com/MrSenko/kiwitcms-enterprise/blob/master/Dockerfile">Dockerfile</a>
201201
for inspiration</li>
202202
</ul>
203+
<p><strong>NOTE:</strong> starting with <a href="/blog/kiwi-tcms-team/2020/07/10/kiwi-tcms-85/">Kiwi TCMS v8.5</a>
204+
external bug tracker integration classes are listed in the <code>EXTERNAL_BUG_TRACKERS</code>
205+
setting. If you are using v8.5 or newer instead of
206+
importing <code>ExtendedBugTracker</code> in <code>tcms/issuetracker/types.py</code> you should
207+
override the list of available bug tracker integrations:</p>
208+
<div class="highlight"><pre><span></span><span class="n">EXTERNAL_BUG_TRACKERS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;mymodule.ExtendedBugTracker&#39;</span><span class="p">)</span>
209+
</pre></div>
210+
211+
203212
<p>Happy testing!</p>
204213
</article>
205214

‎blog/atodorov/2020/07/11/customize-the-information-used-for-1-click-bug-reports/index.html

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Kiwi TCMS - Customize the information used for 1-click bug reports</title>
6+
<meta name="viewport" content="width=device-width,initial-scale=1">
7+
8+
9+
10+
<meta name="description" content="Kiwi TCMS integration with 3rd party bug trackers supports the 1-click bug report feature. However you may want to change how the..." >
11+
12+
<meta name="author" content="Alexander Todorov">
13+
14+
<meta name="tags" content="customization" >
15+
<meta name="twitter:site" content="@KiwiTCMS">
16+
<meta name="twitter:title" content="Customize the information used for 1-click bug reports">
17+
<meta name="twitter:description" content="Kiwi TCMS integration with 3rd party bug trackers supports the 1-click bug report feature. However you may want to change how the...">
18+
<meta name="twitter:card" content="summary_large_image">
19+
<meta property="twitter:image" content="https://kiwitcms.org/images/customization.png">
20+
21+
<meta property="og:site_name" content="Kiwi TCMS">
22+
<meta property="og:type" content="article" />
23+
<meta property="article:author" content="https://kiwitcms.org/blog/atodorov/" />
24+
<meta property="og:url" content="https://kiwitcms.org/blog/atodorov/2020/07/11/customize-the-information-used-for-1-click-bug-reports/" />
25+
<meta property="og:title" content="Customize the information used for 1-click bug reports" />
26+
<meta property="article:published_time" content="2020-07-11 14:20:00+03:00">
27+
<meta property="og:description" content="Kiwi TCMS integration with 3rd party bug trackers supports the 1-click bug report feature. However you may want to change how the...">
28+
29+
<meta property="og:image" content="https://kiwitcms.org/images/customization.png">
30+
<!-- MailChimp Newsletter Form Styles -->
31+
<link href="//cdn-images.mailchimp.com/embedcode/horizontal-slim-10_7.css" rel="stylesheet" type="text/css">
32+
<!-- Custom Styles -->
33+
<link href="/theme/style/style.css" rel="stylesheet">
34+
<link href="/theme/style/color-palette-light.css" rel="stylesheet">
35+
<link href="/theme/style/github.css" rel="stylesheet">
36+
<!-- Other Fonts -->
37+
<link href="https://fonts.googleapis.com/css?family=Zilla+Slab" rel="stylesheet">
38+
<link href="https://fonts.googleapis.com/css?family=Audiowide" rel="stylesheet">
39+
<!-- Font Awesome -->
40+
<link rel="stylesheet" href="/theme/fontawesome-free-5.6.3-web/css/all.min.css">
41+
<!-- Mobile nav script -->
42+
<script type="text/javascript" src="/theme/scripts/mobile-nav.js"></script>
43+
44+
</head>
45+
<body class="" onload="setMobileNavBehaviour()">
46+
<!-- Nav -->
47+
<nav class="col-12 primary">
48+
<a href="/">
49+
<img src="/theme/images/kiwi_logo_h50.png" name="logo">
50+
</a>
51+
<button class="open-menu accent-unimportant"><i class="fa fa-align-justify" aria-hidden="true"></i></button>
52+
<div id="mobile-mask">
53+
<button class="close-menu accent-unimportant"><i class="fa fa-times" aria-hidden="true"></i></button>
54+
<ul class="topnav">
55+
<li><a href="/features/">Features</a></li>
56+
<li><a href="http://kiwitcms.readthedocs.io">Documentation</a></li>
57+
<li><a href="/community/">Community</a></li>
58+
<li><a href="/support/">Support</a></li>
59+
<li><a href="/blog/">Blog</a></li>
60+
<li><a href="/team/">Team</a></li>
61+
<li>
62+
<form action="https://google.com/search" method="get">
63+
<input name="sitesearch" value="https://kiwitcms.org" type="hidden">
64+
<input class="search" name="q" placeholder="Search" type="text">
65+
</form>
66+
</li>
67+
</ul>
68+
</div>
69+
</nav>
70+
<!-- content -->
71+
<header class="col-12 header secondary">
72+
<h1 class="top-header">Customize the information used for 1-click bug reports</h1>
73+
74+
<p class="post-meta">
75+
Posted by
76+
<a href="/blog/atodorov/">Alexander Todorov</a>
77+
on Sat 11 July 2020
78+
under
79+
<a href="/blog/tags/customization/">customization</a>
80+
</p>
81+
</header>
82+
83+
<article class="col-12 article secondary">
84+
<p>Kiwi TCMS integration with 3rd party bug trackers supports the
85+
<em>1-click bug report</em> feature.
86+
However you may want to change how the initial information is structured or
87+
even what exactly is written in the initial comment. This article
88+
shows how to do this.</p>
89+
<p>The default text used for 1-click bug reports gets compiled based on
90+
information present in the TestExecution - Product, Version, TestCase.text,
91+
etc. This is encapsulated in the
92+
<code>tcms.issuetracker.base.IssueTrackerType._report_comment()</code> method.
93+
You may extend the existing bug tracker integration code
94+
with your own customizations. In this example I've extended the
95+
<code>KiwiTCMS</code> bug tracker implementation but you can provide your own from
96+
scratch</p>
97+
<div class="highlight"><pre><span></span><span class="c1"># filename: mymodule.py</span>
98+
<span class="k">class</span> <span class="nc">ExtendedBugTracker</span><span class="p">(</span><span class="n">KiwiTCMS</span><span class="p">):</span>
99+
<span class="k">def</span> <span class="nf">_report_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">execution</span><span class="p">):</span>
100+
<span class="n">comment</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_report_comment</span><span class="p">(</span><span class="n">execution</span><span class="p">)</span>
101+
102+
<span class="n">comment</span> <span class="o">+=</span> <span class="s2">&quot;----- ADDITIONAL INFORMATION -----</span><span class="se">\n\n</span><span class="s2">&quot;</span>
103+
<span class="c1">#</span>
104+
<span class="c1"># fetch more info from other sources</span>
105+
<span class="c1">#</span>
106+
<span class="n">comment</span> <span class="o">+=</span> <span class="s2">&quot;----- END ADDITIONAL INFORMATION -----</span><span class="se">\n</span><span class="s2">&quot;</span>
107+
<span class="k">return</span> <span class="n">comment</span>
108+
</pre></div>
109+
110+
111+
<p>Then override the <code>EXTERNAL_BUG_TRACKERS</code> setting to include your customizations:</p>
112+
<div class="highlight"><pre><span></span><span class="n">EXTERNAL_BUG_TRACKERS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;mymodule.ExtendedBugTracker&#39;</span><span class="p">)</span>
113+
</pre></div>
114+
115+
116+
<p>and change the bug tracker type, via https://tcms.example.com/admin/testcases/bugsystem/,
117+
to <em>mymodule.ExtendedBugTracker</em>.</p>
118+
<p><strong>IMPORTANT</strong></p>
119+
<ul>
120+
<li>Information how to change settings can be found
121+
<a href="https://kiwitcms.readthedocs.io/en/latest/installing_docker.html#customization">here</a></li>
122+
<li><code>mymodule.py</code> may live anywhere on the filesystem but Python must be
123+
able to import it</li>
124+
<li>It is best to bundle all of your customizations into a Python package and
125+
<code>pip3 install</code> it into your customized docker image</li>
126+
<li>API documentation for bug tracker integration can be found
127+
<a href="https://kiwitcms.readthedocs.io/en/latest/modules/tcms.issuetracker.html">here</a></li>
128+
<li>Rebuilding the docker image is outside the scope of this article. Have a look
129+
at this
130+
<a href="https://github.com/MrSenko/kiwitcms-enterprise/blob/master/Dockerfile">Dockerfile</a>
131+
for inspiration</li>
132+
</ul>
133+
<p>Happy testing!</p>
134+
</article>
135+
136+
<!-- Social Sharing Buttons -->
137+
<script type="text/javascript" src="//s7.addthis.com/js/300/addthis_widget.js#pubid=ra-5a8aeaec2954eb1b"></script>
138+
<div class="addthis_inline_share_toolbox secondary"></div>
139+
140+
<!-- Newsletter Form Section -->
141+
<section class="newsletter secondary col-12">
142+
<div id="mc_embed_signup">
143+
<a href="https://kiwitcms.us17.list-manage.com/subscribe/post?u=9b57a21155a3b7c655ae8f922&amp;id=c970a37581">Project news only, GDPR compliant. Subscribe here!</a>
144+
</div>
145+
</section>
146+
<!-- Footer -->
147+
<footer class="col-12 footer primary">
148+
<div class="col-10 footer-copyright">
149+
<p>Kiwi TCMS is collecting donations via <a href="https://opencollective.com/kiwitcms">Open Collective</a>.</p>
150+
<p>Except where otherwise noted, content on this site is licensed under a
151+
<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International license.</a>
152+
</p>
153+
<p><a href="/legal/">Legal information</a></p>
154+
</div>
155+
<div class="col-2">
156+
<ul class="footer-sociallinks">
157+
<li><a href="https://twitter.com/KiwiTCMS"><i class="fab fa-twitter"></i></a></li>
158+
<li><a href="https://github.com/kiwitcms/Kiwi"><i class="fab fa-github"></i></a></li>
159+
</ul>
160+
</div>
161+
</footer>
162+
163+
164+
<!-- Google analytics -->
165+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-113881636-1"></script>
166+
<script>
167+
window.dataLayer = window.dataLayer || [];
168+
function gtag(){
169+
dataLayer.push(arguments);
170+
}
171+
gtag('js', new Date());
172+
gtag('config', 'UA-113881636-1');
173+
</script>
174+
</body>
175+
</html>

‎blog/atodorov/index.html

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,71 @@
5151
</div>
5252
</nav>
5353
<!-- content -->
54+
<section class="col-12 secondary">
55+
<div class="header">
56+
<a href="/blog/atodorov/2020/07/11/customize-the-information-used-for-1-click-bug-reports/" rel="bookmark" title="Permalink to Customize the information used for 1-click bug reports">
57+
<h1 class="top-header">Customize the information used for 1-click bug reports</h1>
58+
</a>
59+
60+
<p class="post-meta">Posted by
61+
<a href="/blog/atodorov/">Alexander Todorov</a>
62+
on Sat 11 July 2020
63+
</p>
64+
</div>
65+
66+
<div class="article">
67+
<p>Kiwi TCMS integration with 3rd party bug trackers supports the
68+
<em>1-click bug report</em> feature.
69+
However you may want to change how the initial information is structured or
70+
even what exactly is written in the initial comment. This article
71+
shows how to do this.</p>
72+
<p>The default text used for 1-click bug reports gets compiled based on
73+
information present in the TestExecution - Product, Version, TestCase.text,
74+
etc. This is encapsulated in the
75+
<code>tcms.issuetracker.base.IssueTrackerType._report_comment()</code> method.
76+
You may extend the existing bug tracker integration code
77+
with your own customizations. In this example I've extended the
78+
<code>KiwiTCMS</code> bug tracker implementation but you can provide your own from
79+
scratch</p>
80+
<div class="highlight"><pre><span></span><span class="c1"># filename: mymodule.py</span>
81+
<span class="k">class</span> <span class="nc">ExtendedBugTracker</span><span class="p">(</span><span class="n">KiwiTCMS</span><span class="p">):</span>
82+
<span class="k">def</span> <span class="nf">_report_comment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">execution</span><span class="p">):</span>
83+
<span class="n">comment</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_report_comment</span><span class="p">(</span><span class="n">execution</span><span class="p">)</span>
84+
85+
<span class="n">comment</span> <span class="o">+=</span> <span class="s2">&quot;----- ADDITIONAL INFORMATION -----</span><span class="se">\n\n</span><span class="s2">&quot;</span>
86+
<span class="c1">#</span>
87+
<span class="c1"># fetch more info from other sources</span>
88+
<span class="c1">#</span>
89+
<span class="n">comment</span> <span class="o">+=</span> <span class="s2">&quot;----- END ADDITIONAL INFORMATION -----</span><span class="se">\n</span><span class="s2">&quot;</span>
90+
<span class="k">return</span> <span class="n">comment</span>
91+
</pre></div>
92+
93+
94+
<p>Then override the <code>EXTERNAL_BUG_TRACKERS</code> setting to include your customizations:</p>
95+
<div class="highlight"><pre><span></span><span class="n">EXTERNAL_BUG_TRACKERS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;mymodule.ExtendedBugTracker&#39;</span><span class="p">)</span>
96+
</pre></div>
97+
98+
99+
<p>and change the bug tracker type, via https://tcms.example.com/admin/testcases/bugsystem/,
100+
to <em>mymodule.ExtendedBugTracker</em>.</p>
101+
<p><strong>IMPORTANT</strong></p>
102+
<ul>
103+
<li>Information how to change settings can be found
104+
<a href="https://kiwitcms.readthedocs.io/en/latest/installing_docker.html#customization">here</a></li>
105+
<li><code>mymodule.py</code> may live anywhere on the filesystem but Python must be
106+
able to import it</li>
107+
<li>It is best to bundle all of your customizations into a Python package and
108+
<code>pip3 install</code> it into your customized docker image</li>
109+
<li>API documentation for bug tracker integration can be found
110+
<a href="https://kiwitcms.readthedocs.io/en/latest/modules/tcms.issuetracker.html">here</a></li>
111+
<li>Rebuilding the docker image is outside the scope of this article. Have a look
112+
at this
113+
<a href="https://github.com/MrSenko/kiwitcms-enterprise/blob/master/Dockerfile">Dockerfile</a>
114+
for inspiration</li>
115+
</ul>
116+
<p>Happy testing!</p>
117+
</div>
118+
</section>
54119
<section class="col-12 secondary">
55120
<div class="header">
56121
<a href="/blog/atodorov/2020/02/11/i-deleted-our-newsletter-from-mailchimp-please-re-subscribe/" rel="bookmark" title="Permalink to I deleted our newsletter from Mailchimp ! Please re-subscribe">
@@ -431,6 +496,15 @@ <h2>Option #2: extend bug tracker integration</h2>
431496
<a href="https://github.com/MrSenko/kiwitcms-enterprise/blob/master/Dockerfile">Dockerfile</a>
432497
for inspiration</li>
433498
</ul>
499+
<p><strong>NOTE:</strong> starting with <a href="/blog/kiwi-tcms-team/2020/07/10/kiwi-tcms-85/">Kiwi TCMS v8.5</a>
500+
external bug tracker integration classes are listed in the <code>EXTERNAL_BUG_TRACKERS</code>
501+
setting. If you are using v8.5 or newer instead of
502+
importing <code>ExtendedBugTracker</code> in <code>tcms/issuetracker/types.py</code> you should
503+
override the list of available bug tracker integrations:</p>
504+
<div class="highlight"><pre><span></span><span class="n">EXTERNAL_BUG_TRACKERS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;mymodule.ExtendedBugTracker&#39;</span><span class="p">)</span>
505+
</pre></div>
506+
507+
434508
<p>Happy testing!</p>
435509
</div>
436510
</section>

‎blog/authors/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h1 class="top-header">Blog authors</h1>
5151

5252
<section class="col-12 article secondary">
5353
<a href="/blog/atodorov/" rel="bookmark">
54-
<h2 class="top-subheader">Alexander Todorov (17)</h2>
54+
<h2 class="top-subheader">Alexander Todorov (18)</h2>
5555
</a>
5656
<a href="/blog/kiwi-tcms-team/" rel="bookmark">
5757
<h2 class="top-subheader">Kiwi TCMS Team (66)</h2>

0 commit comments

Comments
 (0)