commit ba45729ecbd37649bbee97582309d8158d48d603 Author: Manfred Date: Sun Oct 9 11:47:54 2022 +0200 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..5b791c0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,14 @@ +# Set the default behavior, in case people don't have core.autocrlf set. +* text=auto eol=lf + +# Explicitly declare text files you want to always be normalized and converted +# to native line endings on checkout. +*.pm text eol=lf +*.pl text eol=lf +*.hash text eol=lf +*.txt text eol=lf +*.sh text eol=lf + +# Denote all files that are truly binary and should not be modified. +*.hex binary +*.bin binary diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6fddca0 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/fhem_test.yml b/.github/workflows/fhem_test.yml new file mode 100644 index 0000000..0758957 --- /dev/null +++ b/.github/workflows/fhem_test.yml @@ -0,0 +1,97 @@ +name: Fhem UnitTest +on: + push: + branches: + paths: + - 'FHEM/**' + - 'UnitTest/**' + - 't/**' + - '.github/workflows/fhem_test.yml' + + schedule: + - cron: '43 17 * * 1' + +jobs: + update_controls: + env: + CONTROLS_FILENAME: controls_${{ github.event.repository.name }}.txt + runs-on: ubuntu-latest + steps: + - name: Extract branch name + run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/*/})" + id: extract_branch + - name: Checkout Repostory + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: update controls files + uses: fhem/fhem-controls-actions@v2 + with: + filename: ${{env.CONTROLS_FILENAME}} + - name: update CHANGED + run: | + LOG=$(date +"%Y-%m-%d") + LOG+=" - $(git log -1 --pretty=%B)" + echo "$LOG" | cat - CHANGED 2>/dev/null >> temp || true && mv temp CHANGED + - name: git commit back + run: | + git config --global user.email "action@github.com" + git config --local user.name "GitHub Action" + git add CHANGED ${{env.CONTROLS_FILENAME}} || true + git log -1 --name-only --pretty=format: | grep -Eo '[0-9]{2}_.*.pm$' && git commit CHANGED ${{env.CONTROLS_FILENAME}} -m "Automaitc updated controls and CHANGED" || true + - name: git push + uses: ad-m/github-push-action@v0.6.0 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: ${{ steps.extract_branch.outputs.branch }} + test: + runs-on: ubuntu-latest + if: github.event_name == 'push' + strategy: + matrix: + os: ['ubuntu-latest'] + perl: [ '5.22', '5.28', '5.30', '5.32' ] + + name: Perl ${{ matrix.perl }} on ${{ matrix.os }} + steps: + - uses: actions/checkout@v3 + - uses: shogo82148/actions-setup-perl@v1.17.0 + with: + perl-version: ${{ matrix.perl }} + install-modules-with: cpanm + install-modules-args: --notest + - name: install fhem via deb package + run: | + wget -qO - http://debian.fhem.de/archive.key | sudo apt-key add - + echo "deb http://debian.fhem.de/nightly/ /" | sudo tee -a /etc/apt/sources.list + sudo apt-get update -qq + sudo apt-get install fhem -y + sudo systemctl stop fhem + sudo chown -R --reference=README.md /opt/fhem +# - name: run prove on perl modules (testscripts) +# run: prove --exec 'perl -MDevel::Cover=-silent,1 -I FHEM ' -I FHEM -r -vv t/FHEM/ +# - uses: codecov/codecov-action@v1 +# with: +# token: ${{ secrets.CODECOV_TOKEN }} +# file: ./cover_db/clover.xml +# flags: unittests,perl,modules +# name: perl modules (testscripts) ${{ matrix.perl }} + - name: run prove fhem testsuite ${{ matrix.perl }} on modules + run: | + cp -r FHEM/* ${FHEM_DIR}/FHEM/ + cd ${FHEM_DIR} + prove --exec 'perl -MDevel::Cover=-silent,1 fhem.pl -t' -I FHEM -r -vv ${GITHUB_WORKSPACE}/t/FHEM/[0-9][0-9]_*/ + sleep 3 + cp -R /opt/fhem/cover_db ${GITHUB_WORKSPACE}/ + ls -l ${GITHUB_WORKSPACE} + env: + FHEM_DIR: /opt/fhem + - name: Create clover report + run: cover -report clover +# - uses: codecov/codecov-action@v1 +# with: +# token: ${{ secrets.CODECOV_TOKEN }} +# file: ./cover_db/clover.xml +# flags: unittests,fhem,modules +# name: fhem (testscripts) ${{ matrix.perl }} + diff --git a/.github/workflows/perlCritic.yml b/.github/workflows/perlCritic.yml new file mode 100644 index 0000000..c2e563e --- /dev/null +++ b/.github/workflows/perlCritic.yml @@ -0,0 +1,34 @@ +name: Perlcritic check + +on: + pull_request: + types: [opened, synchronize] + + +jobs: + critic: + runs-on: ubuntu-latest + if: github.event_name == 'pull_request' + steps: + - name: Checkout repository + uses: actions/checkout@v3 + - uses: shogo82148/actions-setup-perl@v1.17.0 + with: + perl-version: 5.32 + install-modules-with: cpanm + install-modules: Perl::Critic Task::PerlCriticAllPolicies + install-modules-args: --notest + - uses: reviewdog/action-setup@v1 + with: + reviewdog_version: latest # Optional. [latest,nightly,v.X.Y.Z] + - name: run perlcritic and send report via reviewdog + env: + REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + (perlcritic --verbose 1 --profile .perlcritic ./FHEM; perlcritic --verbose 1 --profile .perlcritic ./lib; ) | \ + reviewdog -efm '%f:%l:%c:%m' \ + -name="perlcritic" \ + -reporter="github-pr-check" \ + -filter-mode="added" \ + -fail-on-error="false" \ + -level="warning" \ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ecf66f8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +!Build/ +.last_cover_stats +/META.yml +/META.json +/MYMETA.* +*.o +*.pm.tdy +*.bs + +# Devel::Cover +cover_db/ + +# Devel::NYTProf +nytprof.out + +# Dizt::Zilla +/.build/ + +# Module::Build +_build/ +Build +Build.bat + +# Module::Install +inc/ + +# ExtUtils::MakeMaker +/blib/ +/_eumm/ +/*.gz +/Makefile +/Makefile.old +/MANIFEST.bak +/pm_to_blib +/*.zip diff --git a/.perlcritic b/.perlcritic new file mode 100644 index 0000000..307b0c7 --- /dev/null +++ b/.perlcritic @@ -0,0 +1,2 @@ +severity = 5 +color = 1 \ No newline at end of file diff --git a/CHANGED b/CHANGED new file mode 100644 index 0000000..399ba76 --- /dev/null +++ b/CHANGED @@ -0,0 +1,18 @@ +2022-01-06 - Update 98_HELLO.pm + +fix critic warning +2021-12-09 - Update 98_HELLO.pm + +generate perlcritic error +2021-02-14 - Add workflow for perlcritc check (#2) + +* Add workflow for perlcritc + +* Update 98_HELLO.pm + +Fix perlcritic errors +2021-02-14 - Fixed perlcritic erros +2021-01-16 - Update 98_HELLO.pm + +Cause critic error +2021-01-06 - Initial commit diff --git a/FHEM/98_HELLO.pm b/FHEM/98_HELLO.pm new file mode 100644 index 0000000..f2558ef --- /dev/null +++ b/FHEM/98_HELLO.pm @@ -0,0 +1,178 @@ +package main; +use strict; +use warnings; + +my %Hello_gets = ( + "whatyouwant" => "can't", + "whatyouneed" => "try sometimes", + "satisfaction" => "no" +); + +sub Hello_Initialize { + my ($hash) = @_; + + $hash->{DefFn} = \&Hello_Define; + $hash->{UndefFn} = \&Hello_Undef; + $hash->{SetFn} = \&Hello_Set; + $hash->{GetFn} = \&Hello_Get; + $hash->{AttrFn} = \&Hello_Attr; + $hash->{ReadFn} = \&Hello_Read; + + $hash->{AttrList} = + "formal:yes,no " + . $readingFnAttributes; +} + +sub Hello_Define { + my ($hash, $def) = @_; + my @param = split('[ \t]+', $def); + + if(int(@param) < 3) { + return "too few parameters: define Hello "; + } + + $hash->{name} = $param[0]; + $hash->{greet} = $param[2]; + + return ; +} + +sub Hello_Undef { + my ($hash, $arg) = @_; + # nothing to do + return ; +} + +sub Hello_Get { + my ($hash, @param) = @_; + + return '"get Hello" needs at least one argument' if (int(@param) < 2); + + my $name = shift @param; + my $opt = shift @param; + if(!$Hello_gets{$opt}) { + my @cList = keys %Hello_gets; + return "Unknown argument $opt, choose one of " . join(" ", @cList); + } + + if($attr{$name}{formal} eq 'yes') { + return $Hello_gets{$opt}.', sir'; + } + return $Hello_gets{$opt}; +} + +sub Hello_Set { + my ($hash, @param) = @_; + + return '"set Hello" needs at least one argument' if (int(@param) < 2); + + my $name = shift @param; + my $opt = shift @param; + my $value = join("", @param); + + if(!defined($Hello_gets{$opt})) { + my @cList = keys %Hello_gets; + return "Unknown argument $opt, choose one of " . join(" ", @cList); + } + $hash->{STATE} = $Hello_gets{$opt} = $value; + + return "$opt set to $value. Try to get it."; +} + + +sub Hello_Attr { + my ($cmd,$name,$attr_name,$attr_value) = @_; + if($cmd eq "set") { + if($attr_name eq "formal") { + if($attr_value !~ /^yes|no$/) { + my $err = "Invalid argument $attr_value to $attr_name. Must be yes or no."; + Log 3, "Hello: ".$err; + return $err; + } + } else { + return "Unknown attr $attr_name"; + } + } + return ; +} + +1; + +=pod +=begin html + + +

Hello

+
    + Hello implements the classical "Hello World" as a starting point for module development. + You may want to copy 98_Hello.pm to start implementing a module of your very own. See + DevelopmentModuleIntro for an + in-depth instruction to your first module. +

    + + Define +
      + define <name> Hello <greet> +

      + Example: define HELLO Hello TurnUrRadioOn +

      + The "greet" parameter has no further meaning, it just demonstrates + how to set a so called "Internal" value. See commandref#define + for more info about the define command. +
    +
    + + + Set
    +
      + set <name> <option> <value> +

      + You can set any value to any of the following options. They're just there to + get them. See commandref#set + for more info about the set command. +

      + Options: +
        +
      • satisfaction
        + Defaults to "no"
        • +
      • whatyouwant
        + Defaults to "can't"
        • +
      • whatyouneed
        + Defaults to "try sometimes"
        • +
      +
    +
    + + + Get
    + +
    + + + Attributes +
      + attr <name> <attribute> <value> +

      + See commandref#attr for more info about + the attr command. +

      + Attributes: +
        +
      • formal no|yes
        + When you set formal to "yes", all output of get will be in a + more formal language. Default is "no". +
        • +
      +
    +
+ +=end html + +=cut diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..39a0343 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# mod_template +Template Repository for your custom Module + +# Files included in this template: + + +## Fhem module files and folders + +### FHEM/98_HELLO.pm + +Hello world module. Included here for demonstration from FHEM Wiki + +Look for development guideof a FHEM Module at the FHEM wiki +https://wiki.fhem.de/wiki/DevelopmentModuleIntro + +Write your own module with your own filename + + +### lib/ + +Put any libs(pure perl modules) you provide in a own package (not main) create in here + + +## automated Testing + + + +### t/FHEM/98_HELLO/* + +Unittests for the fhem mdoule run via github actions if needed you have to write them into folder t/FHEM// + + +### t/FHEM//* + +Unittests for the perl mdoule run via github actions if needed you have to write them into folder t/FHEM// +Unittests (run prove on perl modules (testscripts)) needs to be enabled in the fhem_test.yml workflow + +``` + - name: run prove on perl modules (testscripts) + run: prove --exec 'perl -MDevel::Cover=-silent,1 -I FHEM ' -I FHEM -r -vv t/FHEM/ +``` + +### cpanfile + +Cpan modules needed for running your module and your tests, they will be installed after perl is set up and running + +### .github/workflows/update.yml + +This is a github action workflow which creates a controls file which is needed for fhem update command. +You are then able to install your new module +`update all https://raw.githubusercontent.com/fhem///controls_.txt` + +### .github/workflows/fhem_test.yml + +This is a github action workflow which runs all your tests in t/xx_ folder with different perl versions. + +### .github/dependabot.yml + +Dependabot will check if there are new versions form used actions you are using in your worflows and inform you. + +### Code coverage +You can use codecov (https://about.codecov.io/) to monitor your test code coveage. +Simply enable the coverage action an provide a token vom codecov.io via github secrets + + - uses: codecov/codecov-action@v1 + with: + token: ${{ secrets.CODECOV_TOKEN }} + file: ./cover_db/clover.xml + flags: unittests,fhem,modules + name: fhem (testscripts) ${{ matrix.perl }} + diff --git a/controls_mod_template.txt b/controls_mod_template.txt new file mode 100644 index 0000000..6d91b56 --- /dev/null +++ b/controls_mod_template.txt @@ -0,0 +1 @@ +UPD 2022-01-07_00:05:45 4688 FHEM/98_HELLO.pm diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..4eade56 --- /dev/null +++ b/cpanfile @@ -0,0 +1,4 @@ +requires 'Test2::Suite'; +requires 'Devel::Cover'; +requires 'Devel::Cover::Report::Clover'; +recommends 'Pod::Usage'; diff --git a/t/FHEM/98_HELLO/00_define.t b/t/FHEM/98_HELLO/00_define.t new file mode 100644 index 0000000..028abbd --- /dev/null +++ b/t/FHEM/98_HELLO/00_define.t @@ -0,0 +1,31 @@ +use strict; +use warnings; + +use Test2::V0; +use Test2::Tools::Compare qw{is U}; + +InternalTimer(time()+1, sub() { + my %hash; + $hash{TEMPORARY} = 1; + $hash{NAME} = q{hallo}; + $hash{TYPE} = q{Hello}; + $hash{STAE} = q{???}; + + subtest "Demo Test checking define" => sub { + $hash{DEF} = "howdy"; + plan(2); + my $ret = Hello_Define(\%hash,qq{$hash{NAME} $hash{TYPE}}); + like ($ret, qr/too few parameters: define Hello /, 'check error message Hello_Define'); + + $ret = Hello_Define(\%hash,qq{$hash{NAME} $hash{TYPE} $hash{DEF}}); + is ($ret, U(), 'check returnvalue Hello_Define'); + }; + + + + done_testing(); + exit(0); + +}, 0); + +1; \ No newline at end of file diff --git a/t/FHEM/98_HELLO/fhem.cfg b/t/FHEM/98_HELLO/fhem.cfg new file mode 100644 index 0000000..194c5fe --- /dev/null +++ b/t/FHEM/98_HELLO/fhem.cfg @@ -0,0 +1 @@ +define dummyHello Hello HiHo \ No newline at end of file