OBS QML Type
Interface to OpenSuSE Commander, a.k.a. osc
More...
Import Statement: | import org.nephros.sailfish.OBSMaster 1.0 |
Properties
- apiurl : string
- busy : bool
- cmdError : string
- currentPackage : OBSProject
- currentProject : OBSProject
- filteredPrjList : FilterModel
- hasToken : bool
- initialized : bool
- lastError : string
- lastStatus : string
- projectList : ListModel
- user : string
- userMeta : var
- workerStatusXml : string
Signals
- chumFound(string path)
- chumTestingFound(string path)
- downloadFinished()
- error(string message)
- finished()
- metaReceived(string meta)
- packageCreated()
- projectCreated()
- remoteFilesXmlChanged()
- remoteRunning()
- resultXmlChanged(string which)
- rpmLintLogReceived(string data)
- uploadFinished()
Methods
- abortBuild(pr, pk, repo, arch)
- addFiles(files)
- checkIn()
- checkLogin()
- checkOut(name, limit)
- checkOutProject(name, destination, limit)
- createRemoteProject(pname, parentprj, dobuild, dodebug, dopublish, doufb, extradata)
- getBinaries(repo, arch)
- getBuildInfoDetails(pr, pk, repo, arch)
- getBuildLogUrl(pr, pk, repo, arch)
- getBuildResultInfo(pr, pk, repo, arch, name, extended)
- getBuildResultList(pr, pk, repo, arch)
- getConfig(section, value)
- getDirFileStatus()
- getFileStatus(file)
- getLocalPkgList(path)
- getMetaXml(which, prj, pkg)
- getPrjConfMeta(name)
- getProjectList(root, refresh)
- getRPMLintLog(proj, pkg, repo, arch)
- getRemoteFilesInfo(pr, pk, expand)
- getResults(pr, pk, repo, arch)
- getServiceInfo()
- getWDInfo(dir)
- getWorkerStatus()
- metaFromSpec()
- mkpac(name)
- newPackage(parentobj, properties)
- newProject(parentobj, properties)
- openShell()
- putFile()
- putMeta(which, filepath, projectName, packageName)
- rebuild(prj, pk, repo, arch, opt)
- rebuildAll()
- rebuildFailed()
- rebuildPackage(pr, pk, repo, arch)
- remoteRun()
- runSpectacle(fileurl)
- saveTmpXMLFile(payload, callback)
- setPkgInfoFromPath(dir)
- setPrjInfoFromPath(dir)
- updateWD(what)
- xmlToJSON(xml)
Detailed Description
Singleton. Wraps a Python object (via io.thp.pyotherside) which presents an interface to the osc
tool (as well as some additional/helper functions).
Property Documentation
The API URL for the configured OBS instance. Used e.g. to open stuff in the Browser.
true
when we're doing something, i.e. an asynchronous process has been started and we are awaiting a callback.
Stores the standard error stream of the last command executed by the osc
Python helper.
currentPackage : OBSProject |
Holds the meta data representing a (usually local) Package or Project.
currentProject : OBSProject |
Holds the meta data representing a (usually local) Package or Project.
Holds the list of all known projects (upstream), without user homes.
See also getProjectList and projectList.
true
when the OBSMaster.OBS Singleton has reached a usable state.
Warning: No method calls to this type shall be made before this property has changed to true
.
Store the last activity status or an error message received by the osc
Python helper
See also cmdError.
Store the last activity status or an error message received by the osc
Python helper
See also cmdError.
Holds the list of all known projects (upstream).
See also getProjectList.
user meta data, as an object:
{ "person": { "login": "testuser", "email": "test@example.org", "realname": "-- --", "state": "confirmed", "watchlist": null } }
Holds the build worker statistics
See also getWorkerStatus().
Signal Documentation
Emitted when the current working dir looks like a Chum working dir. Used in the app to store the path to persistent storage.
Emitted when the current working dir looks like a Chum:Testing working dir. Used in the App to store the path to persistent storage.
Emitted when a download has finished. This could be a binary download, or an update or checkout command completing.
Emitted when the API interface reports an error (or anything else written to stderr). message is the content of stderr.
See also cmdError.
Emitted when the remote files list changed
See also OBSPackage::remoteFilesXml.
Emitted when the a remote run has been triggered.
See also remoteRun().
Emitted when the result list changed,
which can be one of:
Constant | Description |
---|---|
project | |
package | which is the content type received. |
See also OBSTypeBase::resultXml.
Method Documentation
Aborts a build of the package pk, repo, and arch corresponding to the arguments
Retrieve an auth token from the server.
Used to check that authorization is set up correctly.
See also SettingsPage.
Check out project name into path destination, optionally applying a size limit limit
Synchronously retrieves build result detail information, returns an JSON String
Returns the public(!) URL (!) of a build log corresponding to the arguments
Synchronously loads the build result detail information, returns a JSON String
Synchronously loads the build result list. Returns and array of objects
Note: pre-0.6, this used to return XML
This QML method was introduced in Qt 0.6.
Retrieve the local configuration values. If parameters section and value are specified, return the value of the relevant setting.
See also SettingsPage.
Calls osc status
on the current working directory
See also getFileStatus.
Calls osc status
on a single file
See also getDirFileStatus.
Reads the list of local packages for a project directory path, and assigns them to a the localPackagesList
property of currentProject
.
See also OBSProject::localPackagesList.
Gets the meta information of type which for prj, pkg by API call. Emits metaReceived() when done.
Gets the meta information for name by API call.
Emits metaReceived() when done.
Retrieves the list of projects from the server.
root - an optional project name to start from refresh - force loading even if already have a list
Updates projectList and filteredPrjList with the information received.
Retrieves an rpmlint log file, using the native osc
python interface.
Emits rpmLintLogReceived() when finished.
Retrieves the list of source files results by calling the OBS API. If expand is true
, the any links are expanded.
Retrieves the list of build results by calling the OBS API. pr is mandatory, pk, repo and arch optional parameters to the call.
Given a local directory dir, tries to determine whether it is a package or project dir, sets up the corresponding types. path will be used to trigger initialization of those types.
Note: this will destroy() current instances of OBSProject and OBSPackage and create new ones.
See also currentProject, currentPackage, newProject(), and newPackage().
Fetches some statistics for the build workers from the OBS API path /worker/_status
.
See also api.
Creates a new local package under currentProject.path
Emits OBS::packageCreated when done
Creates a new OBSPackage object via createObject(). The parentobj, and properties parameters correspond to the parameters of that call.
See also QtQml::Component.createObject().
Creates a new OBSProject object via createObject(). The parentobj, and properties parameters correspond to the parameters of that call.
See also QtQml::Component.createObject().
Upload a meta file filename of type which. projectName is the project name packageName the package name. The latter is required if which is "pkg", and is ignored otherwise.
Emits uploadFinished() on success.
Triggers a rebuild of either all packages of the current project, or the current package, or just for failed packages.
See also OBSMaster::OBS::rebuild().
See also OBSMaster::OBS::rebuild().
See also OBSMaster::OBS::rebuild().
Triggers a remote service run for the current Package. Emits remoteRunning()
Investigates dir, and assigns the various metadata as appropriate.
See also OBSPackage.
Investigates dir, and assigns the various metadata as appropriate.
See also OBSProject.
Calls update
on the current path. what specifies whether we want to update a project or package dir.
Emits downloadFinished() when done.
OBS Master Documentation Copyright (c) 2023 The OBS Master contributors. This document may be used under the terms of the Creative Commons Attribution Share Alike 4.0 International License.