diff --git a/RCUSCC/LICENSE.txt b/RCUSCC/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..11069edd79019f7dafbe3138841cf289209270dd --- /dev/null +++ b/RCUSCC/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/RCUSCC/MANIFEST.in b/RCUSCC/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..d9d9aaba41c43f633c9a02635e72b4eb1b791f50 --- /dev/null +++ b/RCUSCC/MANIFEST.in @@ -0,0 +1,9 @@ +recursive-include RCUSCC *.py +recursive-include test *.py +include *.rst +include RCUSCC.xmi +include *.txt +graft docs + +global-exclude *.pyc +global-exclude *.pyo diff --git a/RCUSCC-DS/RCUSCC.xmi b/RCUSCC/RCUSCC.xmi similarity index 94% rename from RCUSCC-DS/RCUSCC.xmi rename to RCUSCC/RCUSCC.xmi index 7d5483d29da59aad12d24f86984e098c6aa76355..5116b4280c8c9f05e3599ded76652e13ee126fa8 100644 --- a/RCUSCC-DS/RCUSCC.xmi +++ b/RCUSCC/RCUSCC.xmi @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="ASCII"?> <pogoDsl:PogoSystem xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:pogoDsl="http://www.esrf.fr/tango/pogo/PogoDsl"> <classes name="RCUSCC" pogoRevision="9.6"> - <description description="" title="RCU-SCC Device Server for LOFAR2.0" sourcePath="/opt/tango/RCUSCC-DS" language="PythonHL" filestogenerate="XMI file,Code files,Protected Regions" license="APACHE" copyright="" hasMandatoryProperty="true" hasConcreteProperty="true" hasAbstractCommand="false" hasAbstractAttribute="false"> + <description description="" title="RCU-SCC Device Server for LOFAR2.0" sourcePath="/opt/tango/RCUSCC" language="PythonHL" filestogenerate="XMI file,Code files,Python Package,Protected Regions" license="APACHE" copyright="" hasMandatoryProperty="true" hasConcreteProperty="true" hasAbstractCommand="false" hasAbstractAttribute="false"> <inheritances classname="Device_Impl" sourcePath=""/> <identification contact="at astron.nl - jurges" author="jurges" emailDomain="astron.nl" classFamily="OtherInstruments" siteSpecific="" platform="Unix Like" bus="Socket" manufacturer="ASTRON" reference=""/> </description> diff --git a/RCUSCC-DS/RCUSCC.py b/RCUSCC/RCUSCC/RCUSCC.py similarity index 100% rename from RCUSCC-DS/RCUSCC.py rename to RCUSCC/RCUSCC/RCUSCC.py diff --git a/RCUSCC/RCUSCC/__init__.py b/RCUSCC/RCUSCC/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..798097c39269bfde86a914a765a2312c9ddca0d5 --- /dev/null +++ b/RCUSCC/RCUSCC/__init__.py @@ -0,0 +1,19 @@ +# -*- coding: utf-8 -*- +# +# This file is part of the RCUSCC project +# +# +# +# Distributed under the terms of the APACHE license. +# See LICENSE.txt for more info. + +"""RCU-SCC Device Server for LOFAR2.0 + +""" + +from . import release +from .RCUSCC import RCUSCC, main + +__version__ = release.version +__version_info__ = release.version_info +__author__ = release.author diff --git a/RCUSCC/RCUSCC/__main__.py b/RCUSCC/RCUSCC/__main__.py new file mode 100644 index 0000000000000000000000000000000000000000..faeacf59dafd8202ed7f394e88eca8a436ecacba --- /dev/null +++ b/RCUSCC/RCUSCC/__main__.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- +# +# This file is part of the RCUSCC project +# +# +# +# Distributed under the terms of the APACHE license. +# See LICENSE.txt for more info. + +from RCUSCC import main +main() diff --git a/RCUSCC/RCUSCC/release.py b/RCUSCC/RCUSCC/release.py new file mode 100644 index 0000000000000000000000000000000000000000..76da0a9b865d8ee3bbef735c2bc1936cc2eeb8bc --- /dev/null +++ b/RCUSCC/RCUSCC/release.py @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- +# +# This file is part of the RCUSCC project +# +# +# +# Distributed under the terms of the APACHE license. +# See LICENSE.txt for more info. + +"""Release information for Python Package""" + +name = """tangods-rcuscc""" +version = "1.0.0" +version_info = version.split(".") +description = """""" +author = "jurges" +author_email = "jurges at astron.nl" +license = """APACHE""" +url = """www.tango-controls.org""" +copyright = """""" diff --git a/RCUSCC/README.rst b/RCUSCC/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ee3abb0540804329236c97de5b0cfa06f5d3460 --- /dev/null +++ b/RCUSCC/README.rst @@ -0,0 +1,25 @@ +## RCU-SCC Device Server for LOFAR2.0 + + +## Requirement + +- PyTango >= 8.1.6 +- devicetest (for using tests) +- sphinx (for building sphinx documentation) + +## Installation + +Run python setup.py install + +If you want to build sphinx documentation, +run python setup.py build_sphinx + +If you want to pass the tests, +run python setup.py test + +## Usage + +Now you can start your device server in any +Terminal or console by calling it : + +RCUSCC instance_name diff --git a/RCUSCC/setup.py b/RCUSCC/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..991eec9b18cd23cbd50e005604f47cce5a8cc617 --- /dev/null +++ b/RCUSCC/setup.py @@ -0,0 +1,42 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# This file is part of the RCUSCC project +# +# +# +# Distributed under the terms of the APACHE license. +# See LICENSE.txt for more info. + +import os +import sys +from setuptools import setup + +setup_dir = os.path.dirname(os.path.abspath(__file__)) + +# make sure we use latest info from local code +sys.path.insert(0, setup_dir) + +readme_filename = os.path.join(setup_dir, 'README.rst') +with open(readme_filename) as file: + long_description = file.read() + +release_filename = os.path.join(setup_dir, 'RCUSCC', 'release.py') +exec(open(release_filename).read()) + +pack = ['RCUSCC'] + +setup(name=name, + version=version, + description='', + packages=pack, + include_package_data=True, + test_suite="test", + entry_points={'console_scripts':['RCUSCC = RCUSCC:main']}, + author='jurges', + author_email='jurges at astron.nl', + license='APACHE', + long_description=long_description, + url='www.tango-controls.org', + platforms="Unix Like" + ) diff --git a/RCUSCC/test/RCUSCC_test.py b/RCUSCC/test/RCUSCC_test.py new file mode 100644 index 0000000000000000000000000000000000000000..fa25c90d1ab0d4a0b9e40067c9bbc8c8a41b4262 --- /dev/null +++ b/RCUSCC/test/RCUSCC_test.py @@ -0,0 +1,89 @@ +######################################################################################### +# -*- coding: utf-8 -*- +# +# This file is part of the RCUSCC project +# +# +# +# Distributed under the terms of the APACHE license. +# See LICENSE.txt for more info. +######################################################################################### +"""Contain the tests for the RCU-SCC Device Server for LOFAR2.0.""" + +# Path +import sys +import os +path = os.path.join(os.path.dirname(__file__), os.pardir) +sys.path.insert(0, os.path.abspath(path)) + +# Imports +import pytest +from mock import MagicMock + +from PyTango import DevState + +# PROTECTED REGION ID(RCUSCC.test_additional_imports) ENABLED START # +# PROTECTED REGION END # // RCUSCC.test_additional_imports + + +# Device test case +@pytest.mark.usefixtures("tango_context", "initialize_device") +# PROTECTED REGION ID(RCUSCC.test_RCUSCC_decorators) ENABLED START # +# PROTECTED REGION END # // RCUSCC.test_RCUSCC_decorators +class TestRCUSCC(object): + """Test case for packet generation.""" + + properties = { + 'OPC_Server_Name': '', + 'OPC_Server_Port': '', + 'OPC_Time_Out': '', + } + + @classmethod + def mocking(cls): + """Mock external libraries.""" + # Example : Mock numpy + # cls.numpy = RCUSCC.numpy = MagicMock() + # PROTECTED REGION ID(RCUSCC.test_mocking) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_mocking + + def test_properties(self, tango_context): + # Test the properties + # PROTECTED REGION ID(RCUSCC.test_properties) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_properties + pass + + # PROTECTED REGION ID(RCUSCC.test_State_decorators) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_State_decorators + def test_State(self, tango_context): + """Test for State""" + # PROTECTED REGION ID(RCUSCC.test_State) ENABLED START # + assert tango_context.device.State() == DevState.UNKNOWN + # PROTECTED REGION END # // RCUSCC.test_State + + # PROTECTED REGION ID(RCUSCC.test_Status_decorators) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_Status_decorators + def test_Status(self, tango_context): + """Test for Status""" + # PROTECTED REGION ID(RCUSCC.test_Status) ENABLED START # + assert tango_context.device.Status() == "The device is in UNKNOWN state." + # PROTECTED REGION END # // RCUSCC.test_Status + + + # PROTECTED REGION ID(RCUSCC.test_time_offset_rw_decorators) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_time_offset_rw_decorators + def test_time_offset_rw(self, tango_context): + """Test for time_offset_rw""" + # PROTECTED REGION ID(RCUSCC.test_time_offset_rw) ENABLED START # + assert tango_context.device.time_offset_rw == 0 + # PROTECTED REGION END # // RCUSCC.test_time_offset_rw + + # PROTECTED REGION ID(RCUSCC.test_time_offset_r_decorators) ENABLED START # + # PROTECTED REGION END # // RCUSCC.test_time_offset_r_decorators + def test_time_offset_r(self, tango_context): + """Test for time_offset_r""" + # PROTECTED REGION ID(RCUSCC.test_time_offset_r) ENABLED START # + assert tango_context.device.time_offset_r == 0 + # PROTECTED REGION END # // RCUSCC.test_time_offset_r + + diff --git a/RCUSCC/test/__init__.py b/RCUSCC/test/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/RCUSCC-DS/test/test-RCUSCC.py b/RCUSCC/test/test-RCUSCC.py similarity index 100% rename from RCUSCC-DS/test/test-RCUSCC.py rename to RCUSCC/test/test-RCUSCC.py