Skip to content

Commit b7654a3

Browse files
committed
Added distribution/unit-tests
1 parent c19829e commit b7654a3

File tree

2 files changed

+90
-0
lines changed

2 files changed

+90
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.wsjcpp/*
2+
13
# Prerequisites
24
*.d
35

web/index.html

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,90 @@ <h3>include you existsing package for wsjcpp</h3>
301301
type: "source-code"
302302
</textarea>
303303

304+
<hr>
305+
306+
<a class="anchorjs-link " name="usage" aria-label="Anchor" data-anchorjs-icon="#" style="padding-left: 0.375em;"></a>
307+
<h1>Usage</h1>
308+
309+
<h3>wsjcpp info</h3>
310+
Information about current package. Example:
311+
<textarea class="cm-show-code" cm-mode="shell">
312+
===== begin: wsjcpp info =====
313+
Name: wsjcpp
314+
Version: v0.1.1
315+
Description: C++ Source Package manager
316+
Directory: .
317+
wsjcpp.version = v0.0.2
318+
Keywords:
319+
- c++
320+
- sources
321+
322+
Distribution-Files:
323+
- src/wsjcpp_package_manager_distribution_file.cpp -> wsjcpp_package_manager_distribution_file.cpp [source-code]
324+
- src/wsjcpp_package_manager_distribution_file.h -> wsjcpp_package_manager_distribution_file.h [source-code]
325+
- src/wsjcpp_package_manager_safe_scripting_generate.cpp -> wsjcpp_package_manager_safe_scripting_generate.cpp [source-code]
326+
- src/wsjcpp_package_manager_safe_scripting_generate.h -> wsjcpp_package_manager_safe_scripting_generate.h [source-code]
327+
- src/wsjcpp_package_manager.cpp -> wsjcpp_package_manager.cpp[source-code]
328+
- src/wsjcpp_package_manager.h -> wsjcpp_package_manager.h [source-code]
329+
330+
Authors:
331+
- Evgenii Sopov <mrseakg@gmail.com>
332+
333+
Dependencies:
334+
- wsjcpp-core:v0.1.1
335+
- wsjcpp-yaml:v0.1.1
336+
- wsjcpp-hashes:v0.1.0
337+
- wsjcpp-safe-scripting:v0.1.0
338+
- wsjcpp-arguments:v0.1.0
339+
===== end: wsjcpp info =====
340+
341+
</textarea>
342+
<br><br>
343+
<h3>wsjcpp distribution</h3>
344+
Developer define what exectly your package will distributed (without main/trash/unit-tests) - only core code.
345+
<ul>
346+
<li>wsjcpp dist list - list of distribution files</li>
347+
<li>wsjcpp dist add filepath1 - add to distribution files</li>
348+
<li>wsjcpp dist reomve filepath1 - remove to distribution (removed info only from wsjcpp.yml not from filesystem)</li>
349+
</ul>
350+
Example:
351+
<textarea class="cm-show-code" cm-mode="shell">
352+
% wsjcpp dist list
353+
Distribution list:
354+
source-code: 'src/wsjcpp_package_manager_distribution_file.cpp' -> 'wsjcpp_package_manager_distribution_file.cpp'
355+
source-code: 'src/wsjcpp_package_manager_distribution_file.h' -> 'wsjcpp_package_manager_distribution_file.h'
356+
source-code: 'src/wsjcpp_package_manager_safe_scripting_generate.cpp' -> 'wsjcpp_package_manager_safe_scripting_generate.cpp'
357+
source-code: 'src/wsjcpp_package_manager_safe_scripting_generate.h' -> 'wsjcpp_package_manager_safe_scripting_generate.h'
358+
source-code: 'src/wsjcpp_package_manager.cpp' -> 'wsjcpp_package_manager.cpp'
359+
source-code: 'src/wsjcpp_package_manager.h' -> 'wsjcpp_package_manager.h'
360+
% wsjcpp dist add src/some_file.h
361+
Added.
362+
% wsjcpp dist remove src/some_file.h
363+
Removed.
364+
</textarea>
365+
<br><br>
366+
<h3>wsjcpp unit-tests</h3>
367+
Create unit-tests for your distribution files
368+
<ul>
369+
<li>wsjcpp unit-tests list - list of defined unit-tests</li>
370+
<li>wsjcpp unit-tests create NameTest "Description Test" - will be created few files and added to unit-tests/CMakeLists.txt</li>
371+
<li>wsjcpp unit-tests delete NameTest - !!! Removed files and definition from wsjcpp.yml</li>
372+
<li>wsjcpp unit-tests disable NameTest - Disable unit-test (exclude from build/run)</li>
373+
<li>wsjcpp unit-tests enable NameTest - Enable unit-test (include to build/run)</li>
374+
</ul>
375+
Example:
376+
<textarea class="cm-show-code" cm-mode="shell">
377+
% wsjcpp unit-tests list
378+
2020-04-09 11:16:18.097, 0x0x1130c1dc0 [INFO] WsjcppArgumentProcessor-list:
379+
Unit Tests Cases:
380+
* NormalizeUnitTestName - Test Normalize UnitTest Name
381+
* generateFilenameForUnitTest - Test generate filename for UnitTest
382+
* InitPackage - Test for init package
383+
* ReadPackage - Test for read package
384+
% wsjcpp unit-tests create ExampleTest "Some example test"
385+
% wsjcpp unit-tests delete ExampleTest
386+
Unit Test 'ExampleTest' removed successfully.
387+
</textarea>
304388

305389
<hr>
306390

@@ -562,6 +646,10 @@ <h3>idea: wsjcpp clean</h3>
562646
Call the script ./clean.sh
563647
<br><br>
564648

649+
<h3>idea: wsjcpp install -g "url" </h3>
650+
Add installation to global directory in system / or in home user directory
651+
<br><br>
652+
565653
<h3>idea: wsjcpp server-origin start</h3>
566654
<p>Same "registry"</p>
567655
Web server for caching/registry source packages in local network (maybe for inside of company)

0 commit comments

Comments
 (0)