1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/*
Copyright 2017 Aleix Pol Gonzalez <aleixpol@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef DOCKERRUNTIME_H
#define DOCKERRUNTIME_H
#include <interfaces/iruntime.h>
#include <util/path.h>
#include <QHash>
#include <QByteArray>
class KJob;
class DockerPreferencesSettings;
class DockerRuntime : public KDevelop::IRuntime
{
Q_OBJECT
public:
explicit DockerRuntime(const QString& tag);
~DockerRuntime() override;
/**
* @returns the docker tagname as a text identifier
*/
QString name() const override { return m_tag; }
/**
* if @p enabled
* Mounts the docker image's file system into a subdirectory the user can read.
* if not @p enabled, it unmounts the image file system
*
* See GraphDriver.Data.UpperDir value in docker image inspect imagename
*
* Both require root privileges for now
*/
void setEnabled(bool enabled) override;
/**
* Call processes using "docker run..." passing on the proper environment and volumes
*
* Volumes will include source and build directories that need to be exposed
* into the container.
*/
void startProcess(KProcess *process) const override;
void startProcess(QProcess *process) const override;
/**
* Translates @p runtimePath from within the image into the host
*
* Takes into account the mounted upperDir and the different volumes set up
*/
KDevelop::Path pathInHost(const KDevelop::Path & runtimePath) const override;
/**
* Translates @p localPath into a path that can be accessed by the runtime
*/
KDevelop::Path pathInRuntime(const KDevelop::Path & localPath) const override;
QString findExecutable(const QString& executableName) const override;
/**
* @returns the environment variable with @p varname set by the recipe (usually the Dockerfile)
*/
QByteArray getenv(const QByteArray & varname) const override;
KDevelop::Path buildPath() const override { return {}; }
static DockerPreferencesSettings* s_settings;
private:
void inspectContainer();
QStringList workingDirArgs(QProcess* process) const;
const QString m_tag;
QString m_container;
QHash<QByteArray,QByteArray> m_envs;
KDevelop::Path m_mergedDir;
KDevelop::Path m_userMergedDir;
};
#endif
|
