Object wrappers for OBS XML

behave/features/setdevelproject-pkgcheckout.feature

@@ -15,8 +15,6 @@ Scenario: Run `osc setdevelproject <devel_project>`
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgA' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -27,8 +25,6 @@ Scenario: Run `osc setdevelproject <devel_project> <devel_package>`
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgA' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -39,8 +35,6 @@ Scenario: Run `osc setdevelproject <devel_project>/<devel_package>`
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgA' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -52,6 +46,4 @@ Scenario: Run `osc setdevelproject --unset`
      And stdout is
         """
         Unsetting devel project from package 'test:factory/test-pkgA'
-        Sending meta data...
-        Done.
         """

behave/features/setdevelproject-project-package.feature

@@ -13,8 +13,6 @@ Scenario: Run `osc setdevelproject <project> <package> <devel_project>`
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgA' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -25,8 +23,6 @@ Scenario: Run `osc setdevelproject <project> <package> <devel_project> <devel_pa
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgB' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -37,8 +33,6 @@ Scenario: Run `osc setdevelproject  <project>/<package> <devel_project>/<devel_p
      And stdout is
         """
         Setting devel project of package 'test:factory/test-pkgB' to package 'test:devel/test-pkgA'
-        Sending meta data...
-        Done.
         """
 
 
@@ -49,6 +43,4 @@ Scenario: Run `osc setdevelproject <project> <package> --unset`
      And stdout is
         """
         Unsetting devel project from package 'test:factory/test-pkgA'
-        Sending meta data...
-        Done.
         """

osc/core.py

@@ -3864,15 +3864,20 @@
 
 
 def show_devel_project(apiurl, prj, pac):
-    m = show_package_meta(apiurl, prj, pac)
-    node = ET.fromstring(b''.join(m)).find('devel')
-    if node is None:
+    from . import obs_api
+
+    package_obj = obs_api.Package.from_api(apiurl, prj, pac)
+    if package_obj.devel is None:
         return None, None
-    else:
-        return node.get('project'), node.get('package', None)
+
+    # mute a false-positive: Instance of 'dict' has no 'project' member (no-member)
+    # pylint: disable=no-member
+    return package_obj.devel.project, package_obj.devel.package
 
 
 def set_devel_project(apiurl, prj, pac, devprj=None, devpac=None, print_to="debug"):
+    from . import obs_api
+
     if devprj:
         msg = "Setting devel project of"
     else:
@@ -3887,26 +3892,18 @@
     )
     _private.print_msg(msg, print_to=print_to)
 
-    meta = show_package_meta(apiurl, prj, pac)
-    root = ET.fromstring(b''.join(meta))
-    node = root.find('devel')
-    if node is None:
-        if devprj is None:
-            return
-        node = ET.Element('devel')
-        root.append(node)
+    package_obj = obs_api.Package.from_api(apiurl, prj, pac)
+
+    if devprj is None:
+        package_obj.devel = None
     else:
-        if devprj is None:
-            root.remove(node)
-        else:
-            node.clear()
-    if devprj:
-        node.set('project', devprj)
-        if devpac:
-            node.set('package', devpac)
-    url = makeurl(apiurl, ['source', prj, pac, '_meta'])
-    mf = metafile(url, ET.tostring(root, encoding=ET_ENCODING))
-    mf.sync()
+        package_obj.devel = {"project": devprj, "package": devpac}
+
+    if package_obj.has_changed():
+        return package_obj.to_api(apiurl)
+
+    # TODO: debug log that we have skipped the API call
+    return None
 
 
 def show_package_disabled_repos(apiurl: str, prj: str, pac: str):

osc/obs_api/__init__.py

@@ -0,0 +1,2 @@
+from .package import Package
+from .project import Project

osc/obs_api/enums.py

@@ -0,0 +1,79 @@
+from ..util.models import *  # pylint: disable=wildcard-import,unused-wildcard-import
+
+
+class BlockModes(str, Enum):
+    ALL = "all"
+    LOCAL = "local"
+    NEVER = "never"
+
+
+class BuildArch(str, Enum):
+    NOARCH = "noarch"
+    AARCH64 = "aarch64"
+    AARCH64_ILP32 = "aarch64_ilp32"
+    ARMV4L = "armv4l"
+    ARMV5L = "armv5l"
+    ARMV6L = "armv6l"
+    ARMV7L = "armv7l"
+    ARMV5EL = "armv5el"
+    ARMV6EL = "armv6el"
+    ARMV7EL = "armv7el"
+    ARMV7HL = "armv7hl"
+    ARMV8EL = "armv8el"
+    HPPA = "hppa"
+    M68K = "m68k"
+    I386 = "i386"
+    I486 = "i486"
+    I586 = "i586"
+    I686 = "i686"
+    ATHLON = "athlon"
+    IA64 = "ia64"
+    K1OM = "k1om"
+    MIPS = "mips"
+    MIPSEL = "mipsel"
+    MIPS32 = "mips32"
+    MIPS64 = "mips64"
+    MIPS64EL = "mips64el"
+    PPC = "ppc"
+    PPC64 = "ppc64"
+    PPC64P7 = "ppc64p7"
+    PPC64LE = "ppc64le"
+    RISCV64 = "riscv64"
+    S390 = "s390"
+    S390X = "s390x"
+    SH4 = "sh4"
+    SPARC = "sparc"
+    SPARC64 = "sparc64"
+    SPARC64V = "sparc64v"
+    SPARCV8 = "sparcv8"
+    SPARCV9 = "sparcv9"
+    SPARCV9V = "sparcv9v"
+    X86_64 = "x86_64"
+    LOCAL = "local"
+
+
+class LinkedbuildModes(str, Enum):
+    OFF = "off"
+    LOCALDEP = "localdep"
+    ALLDIRECT = "alldirect"
+    ALL = "all"
+
+
+class LocalRole(str, Enum):
+    MAINTAINER = "maintainer"
+    BUGOWNER = "bugowner"
+    REVIEWER = "reviewer"
+    DOWNLOADER = "downloader"
+    READER = "reader"
+
+
+class RebuildModes(str, Enum):
+    TRANSITIVE = "transitive"
+    DIRECT = "direct"
+    LOCAL = "local"
+
+
+class ReleaseTriggers(str, Enum):
+    MANUAL = "manual"
+    MAINTENANCE = "maintenance"
+    OBSGENDIFF = "obsgendiff"

osc/obs_api/flag.py

@@ -0,0 +1,24 @@
+from ..util.models import *  # pylint: disable=wildcard-import,unused-wildcard-import
+
+
+class Flag(XmlModel):
+    XML_TAG = None
+
+    def __init__(self, flag, **kwargs):
+        super().__init__(flag=flag, **kwargs)
+
+    class FlagChoices(Enum):
+        ENABLE = "enable"
+        DISABLE = "disable"
+
+    flag: FlagChoices = Field(
+        xml_set_tag=True,
+    )
+
+    arch: Optional[str] = Field(
+        xml_attribute=True,
+    )
+
+    repository: Optional[str] = Field(
+        xml_attribute=True,
+    )

osc/obs_api/group_role.py

@@ -0,0 +1,15 @@
+from ..util.models import *  # pylint: disable=wildcard-import,unused-wildcard-import
+
+from .enums import LocalRole
+
+
+class GroupRole(XmlModel):
+    XML_TAG = "group"
+
+    groupid: str = Field(
+        xml_attribute=True,
+    )
+
+    role: LocalRole = Field(
+        xml_attribute=True,
+    )

osc/obs_api/package.py

@@ -0,0 +1,127 @@
+from ..util.models import *  # pylint: disable=wildcard-import,unused-wildcard-import
+
+from .flag import Flag
+from .group_role import GroupRole
+from .package_devel import PackageDevel
+from .person_role import PersonRole
+from .simple_flag import SimpleFlag
+from .status import Status
+
+
+class Package(XmlModel):
+    XML_TAG = "package"
+
+    name: str = Field(
+        xml_attribute=True,
+    )
+
+    project: str = Field(
+        xml_attribute=True,
+    )
+
+    title: str = Field()
+
+    description: str = Field()
+
+    devel: Optional[PackageDevel] = Field()
+
+    releasename: Optional[str] = Field()
+
+    person_list: Optional[List[PersonRole]] = Field(
+        xml_name="person",
+    )
+
+    group_list: Optional[List[GroupRole]] = Field(
+        xml_name="group",
+    )
+
+    lock: Optional[SimpleFlag] = Field()
+
+    build_list: Optional[List[Flag]] = Field(
+        xml_name="build",
+        xml_wrapped=True,
+    )
+
+    publish_list: Optional[List[Flag]] = Field(
+        xml_name="publish",
+        xml_wrapped=True,
+    )
+
+    useforbuild_list: Optional[List[Flag]] = Field(
+        xml_name="useforbuild",
+        xml_wrapped=True,
+    )
+
+    debuginfo_list: Optional[List[Flag]] = Field(
+        xml_name="debuginfo",
+        xml_wrapped=True,
+    )
+
+    binarydownload: Optional[SimpleFlag] = Field()
+
+    sourceaccess: Optional[SimpleFlag] = Field()
+
+    url: Optional[str] = Field()
+
+    scmsync: Optional[str] = Field()
+
+    bcntsynctag: Optional[str] = Field()
+
+    @classmethod
+    def from_api(cls, apiurl, project, package, *, rev=None):
+        url_path = ["source", project, package, "_meta"]
+        url_query = {
+            "rev": rev,
+        }
+        response = cls.xml_request("GET", apiurl, url_path, url_query)
+        return cls.from_file(response)
+
+    def to_api(self, apiurl, *, project=None, package=None):
+        project = project or self.project
+        package = package or self.name
+        url_path = ["source", project, package, "_meta"]
+        url_query = {}
+        response = self.xml_request("PUT", apiurl, url_path, url_query, data=self.to_string())
+        return Status.from_file(response)
+
+    @classmethod
+    def cmd_release(
+        cls,
+        apiurl: str,
+        project: str,
+        package: str,
+        *,
+        repository: Optional[str] = None,
+        arch: Optional[str] = None,
+        target_project: Optional[str] = None,
+        target_repository: Optional[str] = None,
+        setrelease: Optional[str] = None,
+        nodelay: Optional[bool] = None,
+    ):
+        """
+        POST /source/{project}/{package}?cmd=release
+        Release sources and binaries of a specified package.
+
+        :param apiurl: Full apiurl or its alias.
+        :param project: Project name.
+        :param package: Package name.
+        :param repository: Limit the release to the given repository.
+        :param arch: Limit the release to the given architecture.
+        :param target_project: The name of the release target project.
+        :param target_repository: The name of the release target repository.
+        :param setrelease: Tag the release with the given value.
+        :param nodelay: Do not delay the relase. If not set, the release will be delayed to be done later.
+        """
+
+        url_path = ["source", project, package]
+        url_query = {
+            "cmd": "release",
+            "repository": repository,
+            "arch": arch,
+            "target_project": target_project,
+            "target_repository": target_repository,
+            "setrelease": setrelease,
+            "nodelay": nodelay,
+        }
+        response = cls.xml_request("POST", apiurl, url_path, url_query)
+        return Status.from_string(response.read())

osc/obs_api/package_devel.py

@@ -0,0 +1,13 @@
+from ..util.models import *  # pylint: disable=wildcard-import,unused-wildcard-import
+
+
+class PackageDevel(XmlModel):
+    XML_TAG = "devel"
+
+    project: str = Field(
+        xml_attribute=True,
+    )
+
+    package: Optional[str] = Field(
+        xml_attribute=True,
+    )